diff --git a/commerce/mod.ts b/commerce/mod.ts index 6e94e5df2..e56d4a0b8 100644 --- a/commerce/mod.ts +++ b/commerce/mod.ts @@ -2,17 +2,19 @@ import { App } from "deco/mod.ts"; import shopify, { Props as ShopifyProps } from "../shopify/mod.ts"; import vnda, { Props as VNDAProps } from "../vnda/mod.ts"; import vtex, { Props as VTEXProps } from "../vtex/mod.ts"; +import wake, { Props as WakeProps } from "../wake/mod.ts"; import website, { Props as WebsiteProps } from "../website/mod.ts"; import manifest, { Manifest } from "./manifest.gen.ts"; export type Props = WebsiteProps & { - commerce: VNDAProps | VTEXProps | ShopifyProps; + commerce: VNDAProps | VTEXProps | ShopifyProps | WakeProps; }; type WebsiteApp = ReturnType; type CommerceApp = | ReturnType | ReturnType + | ReturnType | ReturnType; export default function Site( @@ -25,6 +27,8 @@ export default function Site( ? vnda(commerce) : commerce.platform === "vtex" ? vtex(commerce) + : commerce.platform === "wake" + ? wake(commerce) : shopify(commerce); return { diff --git a/commerce/utils/constants.ts b/commerce/utils/constants.ts new file mode 100644 index 000000000..8182ea846 --- /dev/null +++ b/commerce/utils/constants.ts @@ -0,0 +1,8 @@ +import { ImageObject } from "../types.ts"; + +export const DEFAULT_IMAGE: ImageObject = { + "@type": "ImageObject", + alternateName: "Default Image Placeholder", + url: + "https://ozksgdmyrqcxcwhnbepg.supabase.co/storage/v1/object/public/assets/1818/ff6bb37e-0eab-40e1-a454-86856efc278e", +}; diff --git a/deco.ts b/deco.ts index 8bb88d017..8aea83098 100644 --- a/deco.ts +++ b/deco.ts @@ -13,6 +13,7 @@ const config = { app("handlebars"), app("vtex"), app("vnda"), + app("wake"), app("shopify"), app("website"), app("commerce"), diff --git a/deno.json b/deno.json index 744fc9165..f407d7ac5 100644 --- a/deno.json +++ b/deno.json @@ -3,7 +3,7 @@ "tasks": { "check": "deno fmt && deno lint", "release": "deno eval 'import \"deco/scripts/release.ts\"'", - "start": "deno eval 'import \"deco/scripts/apps/bundle.ts\"'", + "start": "deno run -A ./scripts/start.ts", "link": "deno eval 'import \"deco/scripts/apps/link.ts\"'", "unlink": "deno eval 'import \"deco/scripts/apps/unlink.ts\"'", "serve": "deno eval 'import \"deco/scripts/apps/serve.ts\"'", diff --git a/scripts/start.ts b/scripts/start.ts new file mode 100644 index 000000000..1d25e9745 --- /dev/null +++ b/scripts/start.ts @@ -0,0 +1,199 @@ +import "npm:@graphql-codegen/typescript"; +import "npm:@graphql-codegen/typescript-operations"; + +import { CodegenConfig, generate } from "npm:@graphql-codegen/cli"; +import { + compile, + Options as CompileOptions, +} from "npm:json-schema-to-typescript"; +import { OpenAPIV3 } from "npm:openapi-types"; +import { walk } from "std/fs/mod.ts"; +import { dirname, join } from "std/path/mod.ts"; + +const allOpenAPIPaths: string[] = []; +const allGraphqlPaths: string[] = []; + +for await (const entry of walk(".")) { + if (entry.isFile) { + if (entry.path.endsWith(".openapi.json")) { + allOpenAPIPaths.push(entry.path); + } + if (entry.path.endsWith(".graphql.json")) { + allGraphqlPaths.push(entry.path); + } + } +} + +const openAPISpecsByModule = allOpenAPIPaths.reduce( + (acc, specPath) => { + const dir = dirname(specPath); + + acc[dir] ||= []; + acc[dir].push(specPath); + + return acc; + }, + {} as Record, +); + +// transforms: /a/{b}/c => /a/:b/c +const toPathTemplate = (path: string) => + path.replace(/{/g, ":").replace(/}/g, ""); + +const generateOpenAPI = async () => { + const isOpenAPIv3 = (x: any): x is OpenAPIV3.Document => + x?.openapi?.startsWith("3."); + + const isReferenceObject = (x: any): x is OpenAPIV3.ReferenceObject => x?.$ref; + + const BANNER_COMMENT = ` +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno run -A scripts/openAPI.ts + +`; + + const HTTP_VERBS = ["get", "post", "put", "delete", "patch", "head"] as const; + + const COMPILE_OPTIONS: Partial = { + bannerComment: "", + unknownAny: true, + additionalProperties: false, + format: true, + }; + + const MEDIA_TYPE_JSON = "application/json"; + + const AUTOGEN_TYPE_NAME = "Autogen"; + + for (const [base, paths] of Object.entries(openAPISpecsByModule)) { + const outfile = join(base, "openapi.gen.ts"); + const types = []; + + console.info(`Generating OpenAPI types for specs at ${base}`); + for (const path of paths) { + const document = JSON.parse(await Deno.readTextFile(path)); + + if (!isOpenAPIv3(document)) { + throw new Error("Only OpenAPI@3x is supported"); + } + + for (const [path, pathItem] of Object.entries(document.paths)) { + const pathTemplate = toPathTemplate(path); + + for (const verb of HTTP_VERBS) { + const item = pathItem?.[verb]; + + if (!item) { + continue; + } + + const { + parameters = [], + requestBody, + responses, + summary, + description, + } = item; + + const paramsSchema = parameters + .filter((x): x is OpenAPIV3.ParameterObject => + !isReferenceObject(x) + ) + .filter((x) => x.in === "query") + .reduce((schema, item) => { + if (item.schema && !isReferenceObject(item.schema)) { + schema.properties[item.name] = { + required: item.required as any, + description: item.description, + ...item.schema, + }; + } + + return schema; + }, { + type: "object" as const, + properties: {} as Record, + }); + + const bodySchema = !isReferenceObject(requestBody) && + requestBody?.content?.[MEDIA_TYPE_JSON]?.schema; + + const ok = responses?.["200"] || responses?.["201"] || + responses?.["206"]; + const responseSchema = !isReferenceObject(ok) && + ok?.content?.[MEDIA_TYPE_JSON].schema; + + const [searchParams, body, response] = await Promise.all([ + Object.keys(paramsSchema.properties).length > 0 && paramsSchema, + bodySchema, + responseSchema, + ].map((schema) => + schema ? compile(schema, AUTOGEN_TYPE_NAME, COMPILE_OPTIONS) : null + )); + + const docs = (description || summary) && + `/** @description ${description || summary} */`; + + const typed = `${docs}\n "${verb.toUpperCase()} ${pathTemplate}": { + ${ + Object.entries({ searchParams, body, response }) + .filter((e) => Boolean(e[1])) + .map(([key, value]) => + `${key}: ${ + value!.replace(`export interface ${AUTOGEN_TYPE_NAME}`, "") + .replace(`export type ${AUTOGEN_TYPE_NAME} = `, "") + }` + ) + } + }`; + + types.push(typed); + } + } + } + + await Deno.writeTextFile( + outfile, + `${BANNER_COMMENT}export interface API {\n${types.join("\n")}\n}`, + ); + + // Format using deno + const fmt = new Deno.Command(Deno.execPath(), { args: ["fmt", outfile] }); + await fmt.output(); + } +}; + +const generateGraphQL = async () => { + for (const path of allGraphqlPaths) { + const base = dirname(path); + const [appEntrypoint, ...tail] = base.split("/"); + + console.info(`Generating GraphQL types for specs at ${base}`); + const config: CodegenConfig = { + silent: true, + schema: join(Deno.cwd(), path), + documents: [`./**/*.ts`], + generates: { + [join(...tail, "graphql.gen.ts")]: { + plugins: [ + "typescript", + "typescript-operations", + ], + config: { + skipTypename: true, + enumsAsTypes: true, + }, + }, + }, + }; + + await generate({ ...config, cwd: appEntrypoint }, true); + } +}; + +const generateDeco = () => import("deco/scripts/apps/bundle.ts"); + +await generateOpenAPI(); +await generateGraphQL(); +await generateDeco(); diff --git a/shopify/utils/graphql.gen.ts b/shopify/utils/graphql.gen.ts new file mode 100644 index 000000000..6820a62fd --- /dev/null +++ b/shopify/utils/graphql.gen.ts @@ -0,0 +1,7691 @@ +export type Maybe = T | null; +export type InputMaybe = Maybe; +export type Exact = { [K in keyof T]: T[K] }; +export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; +export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; +export type MakeEmpty = { [_ in K]?: never }; +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +/** All built-in and custom scalars, mapped to their actual values */ +export type Scalars = { + ID: { input: string; output: string; } + String: { input: string; output: string; } + Boolean: { input: boolean; output: boolean; } + Int: { input: number; output: number; } + Float: { input: number; output: number; } + Color: { input: any; output: any; } + DateTime: { input: any; output: any; } + Decimal: { input: any; output: any; } + HTML: { input: any; output: any; } + JSON: { input: any; output: any; } + URL: { input: any; output: any; } + UnsignedInt64: { input: any; output: any; } +}; + +/** + * A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning). + * Versions are commonly referred to by their handle (for example, `2021-10`). + * + */ +export type ApiVersion = { + /** The human-readable name of the version. */ + displayName: Scalars['String']['output']; + /** The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle. */ + handle: Scalars['String']['output']; + /** + * Whether the version is actively supported by Shopify. Supported API versions + * are guaranteed to be stable. Unsupported API versions include unstable, + * release candidate, and end-of-life versions that are marked as unsupported. + * For more information, refer to + * [Versioning](https://shopify.dev/api/usage/versioning). + * + */ + supported: Scalars['Boolean']['output']; +}; + +/** + * The input fields for submitting Apple Pay payment method information for checkout. + * + */ +export type ApplePayWalletContentInput = { + /** The customer's billing address. */ + billingAddress: MailingAddressInput; + /** The data for the Apple Pay wallet. */ + data: Scalars['String']['input']; + /** The header data for the Apple Pay wallet. */ + header: ApplePayWalletHeaderInput; + /** The last digits of the card used to create the payment. */ + lastDigits?: InputMaybe; + /** The signature for the Apple Pay wallet. */ + signature: Scalars['String']['input']; + /** The version for the Apple Pay wallet. */ + version: Scalars['String']['input']; +}; + +/** + * The input fields for submitting wallet payment method information for checkout. + * + */ +export type ApplePayWalletHeaderInput = { + /** The application data for the Apple Pay wallet. */ + applicationData?: InputMaybe; + /** The ephemeral public key for the Apple Pay wallet. */ + ephemeralPublicKey: Scalars['String']['input']; + /** The public key hash for the Apple Pay wallet. */ + publicKeyHash: Scalars['String']['input']; + /** The transaction ID for the Apple Pay wallet. */ + transactionId: Scalars['String']['input']; +}; + +/** Details about the gift card used on the checkout. */ +export type AppliedGiftCard = Node & { + /** The amount that was taken from the gift card by applying it. */ + amountUsed: MoneyV2; + /** + * The amount that was taken from the gift card by applying it. + * @deprecated Use `amountUsed` instead. + */ + amountUsedV2: MoneyV2; + /** The amount left on the gift card. */ + balance: MoneyV2; + /** + * The amount left on the gift card. + * @deprecated Use `balance` instead. + */ + balanceV2: MoneyV2; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The last characters of the gift card. */ + lastCharacters: Scalars['String']['output']; + /** The amount that was applied to the checkout in its currency. */ + presentmentAmountUsed: MoneyV2; +}; + +/** An article in an online store blog. */ +export type Article = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** + * The article's author. + * @deprecated Use `authorV2` instead. + */ + author: ArticleAuthor; + /** The article's author. */ + authorV2?: Maybe; + /** The blog that the article belongs to. */ + blog: Blog; + /** List of comments posted on the article. */ + comments: CommentConnection; + /** Stripped content of the article, single line with HTML tags removed. */ + content: Scalars['String']['output']; + /** The content of the article, complete with HTML formatting. */ + contentHtml: Scalars['HTML']['output']; + /** Stripped excerpt of the article, single line with HTML tags removed. */ + excerpt?: Maybe; + /** The excerpt of the article, complete with HTML formatting. */ + excerptHtml?: Maybe; + /** A human-friendly unique string for the Article automatically generated from its title. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The image associated with the article. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The date and time when the article was published. */ + publishedAt: Scalars['DateTime']['output']; + /** The article’s SEO information. */ + seo?: Maybe; + /** + * A categorization that a article can be tagged with. + * + */ + tags: Array; + /** The article’s name. */ + title: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; +}; + + +/** An article in an online store blog. */ +export type ArticleCommentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** An article in an online store blog. */ +export type ArticleContentArgs = { + truncateAt?: InputMaybe; +}; + + +/** An article in an online store blog. */ +export type ArticleExcerptArgs = { + truncateAt?: InputMaybe; +}; + + +/** An article in an online store blog. */ +export type ArticleMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** An article in an online store blog. */ +export type ArticleMetafieldsArgs = { + identifiers: Array; +}; + +/** The author of an article. */ +export type ArticleAuthor = { + /** The author's bio. */ + bio?: Maybe; + /** The author’s email. */ + email: Scalars['String']['output']; + /** The author's first name. */ + firstName: Scalars['String']['output']; + /** The author's last name. */ + lastName: Scalars['String']['output']; + /** The author's full name. */ + name: Scalars['String']['output']; +}; + +/** + * An auto-generated type for paginating through multiple Articles. + * + */ +export type ArticleConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ArticleEdge. */ + nodes: Array
; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Article and a cursor during pagination. + * + */ +export type ArticleEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of ArticleEdge. */ + node: Article; +}; + +/** The set of valid sort keys for the Article query. */ +export type ArticleSortKeys = + /** Sort by the `author` value. */ + | 'AUTHOR' + /** Sort by the `blog_title` value. */ + | 'BLOG_TITLE' + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `published_at` value. */ + | 'PUBLISHED_AT' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE' + /** Sort by the `updated_at` value. */ + | 'UPDATED_AT'; + +/** Represents a generic custom attribute. */ +export type Attribute = { + /** Key or name of the attribute. */ + key: Scalars['String']['output']; + /** Value of the attribute. */ + value?: Maybe; +}; + +/** The input fields for an attribute. */ +export type AttributeInput = { + /** Key or name of the attribute. */ + key: Scalars['String']['input']; + /** Value of the attribute. */ + value: Scalars['String']['input']; +}; + +/** + * Automatic discount applications capture the intentions of a discount that was automatically applied. + * + */ +export type AutomaticDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** Which lines of targetType that the discount is allocated over. */ + targetSelection: DiscountApplicationTargetSelection; + /** The type of line that the discount is applicable towards. */ + targetType: DiscountApplicationTargetType; + /** The title of the application. */ + title: Scalars['String']['output']; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** A collection of available shipping rates for a checkout. */ +export type AvailableShippingRates = { + /** + * Whether or not the shipping rates are ready. + * The `shippingRates` field is `null` when this value is `false`. + * This field should be polled until its value becomes `true`. + * + */ + ready: Scalars['Boolean']['output']; + /** The fetched shipping rates. `null` until the `ready` field is `true`. */ + shippingRates?: Maybe>; +}; + +/** + * An object with an ID field to support global identification, in accordance with the + * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). + * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) + * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * + */ +export type BaseCartLine = { + /** An attribute associated with the cart line. */ + attribute?: Maybe; + /** The attributes associated with the cart line. Attributes are represented as key-value pairs. */ + attributes: Array; + /** The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. */ + cost: CartLineCost; + /** The discounts that have been applied to the cart line. */ + discountAllocations: Array; + /** + * The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout. + * @deprecated Use `cost` instead. + */ + estimatedCost: CartLineEstimatedCost; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The merchandise that the buyer intends to purchase. */ + merchandise: Merchandise; + /** The quantity of the merchandise that the customer intends to purchase. */ + quantity: Scalars['Int']['output']; + /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ + sellingPlanAllocation?: Maybe; +}; + + +/** + * An object with an ID field to support global identification, in accordance with the + * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). + * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) + * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * + */ +export type BaseCartLineAttributeArgs = { + key: Scalars['String']['input']; +}; + +/** + * An auto-generated type for paginating through multiple BaseCartLines. + * + */ +export type BaseCartLineConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in BaseCartLineEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one BaseCartLine and a cursor during pagination. + * + */ +export type BaseCartLineEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of BaseCartLineEdge. */ + node: BaseCartLine; +}; + +/** An online store blog. */ +export type Blog = HasMetafields & Node & OnlineStorePublishable & { + /** Find an article by its handle. */ + articleByHandle?: Maybe
; + /** List of the blog's articles. */ + articles: ArticleConnection; + /** The authors who have contributed to the blog. */ + authors: Array; + /** + * A human-friendly unique string for the Blog automatically generated from its title. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The blog's SEO information. */ + seo?: Maybe; + /** The blogs’s title. */ + title: Scalars['String']['output']; +}; + + +/** An online store blog. */ +export type BlogArticleByHandleArgs = { + handle: Scalars['String']['input']; +}; + + +/** An online store blog. */ +export type BlogArticlesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** An online store blog. */ +export type BlogMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** An online store blog. */ +export type BlogMetafieldsArgs = { + identifiers: Array; +}; + +/** + * An auto-generated type for paginating through multiple Blogs. + * + */ +export type BlogConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in BlogEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Blog and a cursor during pagination. + * + */ +export type BlogEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of BlogEdge. */ + node: Blog; +}; + +/** The set of valid sort keys for the Blog query. */ +export type BlogSortKeys = + /** Sort by the `handle` value. */ + | 'HANDLE' + /** Sort by the `id` value. */ + | 'ID' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE'; + +/** + * The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets). + * + */ +export type Brand = { + /** The colors of the store's brand. */ + colors: BrandColors; + /** The store's cover image. */ + coverImage?: Maybe; + /** The store's default logo. */ + logo?: Maybe; + /** The store's short description. */ + shortDescription?: Maybe; + /** The store's slogan. */ + slogan?: Maybe; + /** The store's preferred logo for square UI elements. */ + squareLogo?: Maybe; +}; + +/** + * A group of related colors for the shop's brand. + * + */ +export type BrandColorGroup = { + /** The background color. */ + background?: Maybe; + /** The foreground color. */ + foreground?: Maybe; +}; + +/** + * The colors of the shop's brand. + * + */ +export type BrandColors = { + /** The shop's primary brand colors. */ + primary: Array; + /** The shop's secondary brand colors. */ + secondary: Array; +}; + +/** Card brand, such as Visa or Mastercard, which can be used for payments. */ +export type CardBrand = + /** American Express. */ + | 'AMERICAN_EXPRESS' + /** Diners Club. */ + | 'DINERS_CLUB' + /** Discover. */ + | 'DISCOVER' + /** JCB. */ + | 'JCB' + /** Mastercard. */ + | 'MASTERCARD' + /** Visa. */ + | 'VISA'; + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type Cart = HasMetafields & Node & { + /** An attribute associated with the cart. */ + attribute?: Maybe; + /** The attributes associated with the cart. Attributes are represented as key-value pairs. */ + attributes: Array; + /** Information about the buyer that's interacting with the cart. */ + buyerIdentity: CartBuyerIdentity; + /** The URL of the checkout for the cart. */ + checkoutUrl: Scalars['URL']['output']; + /** + * The estimated costs that the buyer will pay at checkout. The costs are subject + * to change and changes will be reflected at checkout. The `cost` field uses the + * `buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * + */ + cost: CartCost; + /** The date and time when the cart was created. */ + createdAt: Scalars['DateTime']['output']; + /** + * The delivery groups available for the cart, based on the buyer identity default + * delivery address preference or the default address of the logged-in customer. + * + */ + deliveryGroups: CartDeliveryGroupConnection; + /** The discounts that have been applied to the entire cart. */ + discountAllocations: Array; + /** The case-insensitive discount codes that the customer added at checkout. */ + discountCodes: Array; + /** + * The estimated costs that the buyer will pay at checkout. + * The estimated costs are subject to change and changes will be reflected at checkout. + * The `estimatedCost` field uses the `buyerIdentity` field to determine + * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * + * @deprecated Use `cost` instead. + */ + estimatedCost: CartEstimatedCost; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** A list of lines containing information about the items the customer intends to purchase. */ + lines: BaseCartLineConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** A note that's associated with the cart. For example, the note can be a personalized message to the buyer. */ + note?: Maybe; + /** The total number of items in the cart. */ + totalQuantity: Scalars['Int']['output']; + /** The date and time when the cart was updated. */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type CartAttributeArgs = { + key: Scalars['String']['input']; +}; + + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type CartDeliveryGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type CartLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type CartMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** + * A cart represents the merchandise that a buyer intends to purchase, + * and the estimated cost associated with the cart. Learn how to + * [interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * during a customer's session. + * + */ +export type CartMetafieldsArgs = { + identifiers: Array; +}; + +/** Return type for `cartAttributesUpdate` mutation. */ +export type CartAttributesUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The discounts automatically applied to the cart line based on prerequisites that have been met. */ +export type CartAutomaticDiscountAllocation = CartDiscountAllocation & { + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2; + /** The title of the allocated discount. */ + title: Scalars['String']['output']; +}; + +/** Represents information about the buyer that is interacting with the cart. */ +export type CartBuyerIdentity = { + /** The country where the buyer is located. */ + countryCode?: Maybe; + /** The customer account associated with the cart. */ + customer?: Maybe; + /** + * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. + * The rank of the preferences is determined by the order of the addresses in the array. Preferences + * can be used to populate relevant fields in the checkout flow. + * + */ + deliveryAddressPreferences: Array; + /** The email address of the buyer that's interacting with the cart. */ + email?: Maybe; + /** The phone number of the buyer that's interacting with the cart. */ + phone?: Maybe; + /** + * A set of wallet preferences tied to the buyer that is interacting with the cart. + * Preferences can be used to populate relevant payment fields in the checkout flow. + * + */ + walletPreferences: Array; +}; + +/** + * Specifies the input fields to update the buyer information associated with a cart. + * Buyer identity is used to determine + * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * and should match the customer's shipping address. + * + */ +export type CartBuyerIdentityInput = { + /** The country where the buyer is located. */ + countryCode?: InputMaybe; + /** The access token used to identify the customer associated with the cart. */ + customerAccessToken?: InputMaybe; + /** + * An ordered set of delivery addresses tied to the buyer that is interacting with the cart. + * The rank of the preferences is determined by the order of the addresses in the array. Preferences + * can be used to populate relevant fields in the checkout flow. + * + */ + deliveryAddressPreferences?: InputMaybe>; + /** The email address of the buyer that is interacting with the cart. */ + email?: InputMaybe; + /** The phone number of the buyer that is interacting with the cart. */ + phone?: InputMaybe; + /** + * A set of wallet preferences tied to the buyer that is interacting with the cart. + * Preferences can be used to populate relevant payment fields in the checkout flow. + * Accepted value: `["shop_pay"]`. + * + */ + walletPreferences?: InputMaybe>; +}; + +/** Return type for `cartBuyerIdentityUpdate` mutation. */ +export type CartBuyerIdentityUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * Represents how credit card details are provided for a direct payment. + * + */ +export type CartCardSource = + /** + * The credit card was provided by a third party and vaulted on their system. + * Using this value requires a separate permission from Shopify. + * + */ + | 'SAVED_CREDIT_CARD'; + +/** The discount that has been applied to the cart line using a discount code. */ +export type CartCodeDiscountAllocation = CartDiscountAllocation & { + /** The code used to apply the discount. */ + code: Scalars['String']['output']; + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2; +}; + +/** The completion action to checkout a cart. */ +export type CartCompletionAction = CompletePaymentChallenge; + +/** The required completion action to checkout a cart. */ +export type CartCompletionActionRequired = { + /** The action required to complete the cart completion attempt. */ + action?: Maybe; + /** The ID of the cart completion attempt. */ + id: Scalars['String']['output']; +}; + +/** The result of a cart completion attempt. */ +export type CartCompletionAttemptResult = CartCompletionActionRequired | CartCompletionFailed | CartCompletionProcessing | CartCompletionSuccess; + +/** A failed completion to checkout a cart. */ +export type CartCompletionFailed = { + /** The errors that caused the checkout to fail. */ + errors: Array; + /** The ID of the cart completion attempt. */ + id: Scalars['String']['output']; +}; + +/** A cart checkout completion that's still processing. */ +export type CartCompletionProcessing = { + /** The ID of the cart completion attempt. */ + id: Scalars['String']['output']; + /** The number of milliseconds to wait before polling again. */ + pollDelay: Scalars['Int']['output']; +}; + +/** A successful completion to checkout a cart and a created order. */ +export type CartCompletionSuccess = { + /** The date and time when the job completed. */ + completedAt?: Maybe; + /** The ID of the cart completion attempt. */ + id: Scalars['String']['output']; + /** The ID of the order that's created in Shopify. */ + orderId: Scalars['ID']['output']; + /** The URL of the order confirmation in Shopify. */ + orderUrl: Scalars['URL']['output']; +}; + +/** + * The costs that the buyer will pay at checkout. + * The cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine + * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * + */ +export type CartCost = { + /** + * The estimated amount, before taxes and discounts, for the customer to pay at + * checkout. The checkout charge amount doesn't include any deferred payments + * that'll be paid at a later date. If the cart has no deferred payments, then + * the checkout charge amount is equivalent to `subtotalAmount`. + * + */ + checkoutChargeAmount: MoneyV2; + /** The amount, before taxes and cart-level discounts, for the customer to pay. */ + subtotalAmount: MoneyV2; + /** Whether the subtotal amount is estimated. */ + subtotalAmountEstimated: Scalars['Boolean']['output']; + /** The total amount for the customer to pay. */ + totalAmount: MoneyV2; + /** Whether the total amount is estimated. */ + totalAmountEstimated: Scalars['Boolean']['output']; + /** The duty amount for the customer to pay at checkout. */ + totalDutyAmount?: Maybe; + /** Whether the total duty amount is estimated. */ + totalDutyAmountEstimated: Scalars['Boolean']['output']; + /** The tax amount for the customer to pay at checkout. */ + totalTaxAmount?: Maybe; + /** Whether the total tax amount is estimated. */ + totalTaxAmountEstimated: Scalars['Boolean']['output']; +}; + +/** Return type for `cartCreate` mutation. */ +export type CartCreatePayload = { + /** The new cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The discounts automatically applied to the cart line based on prerequisites that have been met. */ +export type CartCustomDiscountAllocation = CartDiscountAllocation & { + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2; + /** The title of the allocated discount. */ + title: Scalars['String']['output']; +}; + +/** Information about the options available for one or more line items to be delivered to a specific address. */ +export type CartDeliveryGroup = { + /** A list of cart lines for the delivery group. */ + cartLines: BaseCartLineConnection; + /** The destination address for the delivery group. */ + deliveryAddress: MailingAddress; + /** The delivery options available for the delivery group. */ + deliveryOptions: Array; + /** The ID for the delivery group. */ + id: Scalars['ID']['output']; + /** The selected delivery option for the delivery group. */ + selectedDeliveryOption?: Maybe; +}; + + +/** Information about the options available for one or more line items to be delivered to a specific address. */ +export type CartDeliveryGroupCartLinesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple CartDeliveryGroups. + * + */ +export type CartDeliveryGroupConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CartDeliveryGroupEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination. + * + */ +export type CartDeliveryGroupEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of CartDeliveryGroupEdge. */ + node: CartDeliveryGroup; +}; + +/** Information about a delivery option. */ +export type CartDeliveryOption = { + /** The code of the delivery option. */ + code?: Maybe; + /** The method for the delivery option. */ + deliveryMethodType: DeliveryMethodType; + /** The description of the delivery option. */ + description?: Maybe; + /** The estimated cost for the delivery option. */ + estimatedCost: MoneyV2; + /** The unique identifier of the delivery option. */ + handle: Scalars['String']['output']; + /** The title of the delivery option. */ + title?: Maybe; +}; + +/** + * The input fields for submitting direct payment method information for checkout. + * + */ +export type CartDirectPaymentMethodInput = { + /** The customer's billing address. */ + billingAddress: MailingAddressInput; + /** The source of the credit card payment. */ + cardSource?: InputMaybe; + /** The session ID for the direct payment method used to create the payment. */ + sessionId: Scalars['String']['input']; +}; + +/** The discounts that have been applied to the cart line. */ +export type CartDiscountAllocation = { + /** The discounted amount that has been applied to the cart line. */ + discountedAmount: MoneyV2; +}; + +/** The discount codes applied to the cart. */ +export type CartDiscountCode = { + /** Whether the discount code is applicable to the cart's current contents. */ + applicable: Scalars['Boolean']['output']; + /** The code for the discount. */ + code: Scalars['String']['output']; +}; + +/** Return type for `cartDiscountCodesUpdate` mutation. */ +export type CartDiscountCodesUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `CartUserError`. */ +export type CartErrorCode = + /** The input value is invalid. */ + | 'INVALID' + /** Delivery group was not found in cart. */ + | 'INVALID_DELIVERY_GROUP' + /** Delivery option was not valid. */ + | 'INVALID_DELIVERY_OPTION' + /** Merchandise line was not found in cart. */ + | 'INVALID_MERCHANDISE_LINE' + /** The metafields were not valid. */ + | 'INVALID_METAFIELDS' + /** The payment wasn't valid. */ + | 'INVALID_PAYMENT' + /** Cannot update payment on an empty cart */ + | 'INVALID_PAYMENT_EMPTY_CART' + /** The input value should be less than the maximum value allowed. */ + | 'LESS_THAN' + /** Missing discount code. */ + | 'MISSING_DISCOUNT_CODE' + /** Missing note. */ + | 'MISSING_NOTE' + /** The payment method is not supported. */ + | 'PAYMENT_METHOD_NOT_SUPPORTED'; + +/** + * The estimated costs that the buyer will pay at checkout. + * The estimated cost uses + * [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) + * to determine + * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * + */ +export type CartEstimatedCost = { + /** The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`. */ + checkoutChargeAmount: MoneyV2; + /** The estimated amount, before taxes and discounts, for the customer to pay. */ + subtotalAmount: MoneyV2; + /** The estimated total amount for the customer to pay. */ + totalAmount: MoneyV2; + /** The estimated duty amount for the customer to pay at checkout. */ + totalDutyAmount?: Maybe; + /** The estimated tax amount for the customer to pay at checkout. */ + totalTaxAmount?: Maybe; +}; + +/** + * The input fields for submitting a billing address without a selected payment method. + * + */ +export type CartFreePaymentMethodInput = { + /** The customer's billing address. */ + billingAddress: MailingAddressInput; +}; + +/** The input fields to create a cart. */ +export type CartInput = { + /** An array of key-value pairs that contains additional information about the cart. */ + attributes?: InputMaybe>; + /** + * The customer associated with the cart. Used to determine [international pricing] + * (https://shopify.dev/custom-storefronts/internationalization/international-pricing). + * Buyer identity should match the customer's shipping address. + * + */ + buyerIdentity?: InputMaybe; + /** + * The case-insensitive discount codes that the customer added at checkout. + * + */ + discountCodes?: InputMaybe>; + /** A list of merchandise lines to add to the cart. */ + lines?: InputMaybe>; + /** The metafields to associate with this cart. */ + metafields?: InputMaybe>; + /** + * A note that's associated with the cart. For example, the note can be a personalized message to the buyer. + * + */ + note?: InputMaybe; +}; + +/** The input fields for a cart metafield value to set. */ +export type CartInputMetafieldInput = { + /** The key name of the metafield. */ + key: Scalars['String']['input']; + /** + * The type of data that the cart metafield stores. + * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). + * + */ + type: Scalars['String']['input']; + /** + * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. + * + */ + value: Scalars['String']['input']; +}; + +/** Represents information about the merchandise in the cart. */ +export type CartLine = BaseCartLine & Node & { + /** An attribute associated with the cart line. */ + attribute?: Maybe; + /** The attributes associated with the cart line. Attributes are represented as key-value pairs. */ + attributes: Array; + /** The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. */ + cost: CartLineCost; + /** The discounts that have been applied to the cart line. */ + discountAllocations: Array; + /** + * The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout. + * @deprecated Use `cost` instead. + */ + estimatedCost: CartLineEstimatedCost; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The merchandise that the buyer intends to purchase. */ + merchandise: Merchandise; + /** The quantity of the merchandise that the customer intends to purchase. */ + quantity: Scalars['Int']['output']; + /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ + sellingPlanAllocation?: Maybe; +}; + + +/** Represents information about the merchandise in the cart. */ +export type CartLineAttributeArgs = { + key: Scalars['String']['input']; +}; + +/** The cost of the merchandise line that the buyer will pay at checkout. */ +export type CartLineCost = { + /** The amount of the merchandise line. */ + amountPerQuantity: MoneyV2; + /** The compare at amount of the merchandise line. */ + compareAtAmountPerQuantity?: Maybe; + /** The cost of the merchandise line before line-level discounts. */ + subtotalAmount: MoneyV2; + /** The total cost of the merchandise line. */ + totalAmount: MoneyV2; +}; + +/** + * The estimated cost of the merchandise line that the buyer will pay at checkout. + * + */ +export type CartLineEstimatedCost = { + /** The amount of the merchandise line. */ + amount: MoneyV2; + /** The compare at amount of the merchandise line. */ + compareAtAmount?: Maybe; + /** The estimated cost of the merchandise line before discounts. */ + subtotalAmount: MoneyV2; + /** The estimated total cost of the merchandise line. */ + totalAmount: MoneyV2; +}; + +/** The input fields to create a merchandise line on a cart. */ +export type CartLineInput = { + /** An array of key-value pairs that contains additional information about the merchandise line. */ + attributes?: InputMaybe>; + /** The ID of the merchandise that the buyer intends to purchase. */ + merchandiseId: Scalars['ID']['input']; + /** The quantity of the merchandise. */ + quantity?: InputMaybe; + /** The ID of the selling plan that the merchandise is being purchased with. */ + sellingPlanId?: InputMaybe; +}; + +/** The input fields to update a line item on a cart. */ +export type CartLineUpdateInput = { + /** An array of key-value pairs that contains additional information about the merchandise line. */ + attributes?: InputMaybe>; + /** The ID of the merchandise line. */ + id: Scalars['ID']['input']; + /** The ID of the merchandise for the line item. */ + merchandiseId?: InputMaybe; + /** The quantity of the line item. */ + quantity?: InputMaybe; + /** The ID of the selling plan that the merchandise is being purchased with. */ + sellingPlanId?: InputMaybe; +}; + +/** Return type for `cartLinesAdd` mutation. */ +export type CartLinesAddPayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `cartLinesRemove` mutation. */ +export type CartLinesRemovePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `cartLinesUpdate` mutation. */ +export type CartLinesUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields to delete a cart metafield. */ +export type CartMetafieldDeleteInput = { + /** + * The key name of the cart metafield. Can either be a composite key (`namespace.key`) or a simple key + * that relies on the default app-reserved namespace. + * + */ + key: Scalars['String']['input']; + /** The ID of the cart resource. */ + ownerId: Scalars['ID']['input']; +}; + +/** Return type for `cartMetafieldDelete` mutation. */ +export type CartMetafieldDeletePayload = { + /** The ID of the deleted cart metafield. */ + deletedId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The input fields for a cart metafield value to set. */ +export type CartMetafieldsSetInput = { + /** The key name of the cart metafield. */ + key: Scalars['String']['input']; + /** The ID of the cart resource. */ + ownerId: Scalars['ID']['input']; + /** + * The type of data that the cart metafield stores. + * The type of data must be a [supported type](https://shopify.dev/apps/metafields/types). + * + */ + type: Scalars['String']['input']; + /** + * The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type. + * + */ + value: Scalars['String']['input']; +}; + +/** Return type for `cartMetafieldsSet` mutation. */ +export type CartMetafieldsSetPayload = { + /** The list of cart metafields that were set. */ + metafields?: Maybe>; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `cartNoteUpdate` mutation. */ +export type CartNoteUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for updating the payment method that will be used to checkout. + * + */ +export type CartPaymentInput = { + /** The amount that the customer will be charged at checkout. */ + amount: MoneyInput; + /** + * The input fields to use when checking out a cart with a direct payment method (like a credit card). + * + */ + directPaymentMethod?: InputMaybe; + /** + * The input fields to use to checkout a cart without providing a payment method. + * Use this payment method input if the total cost of the cart is 0. + * + */ + freePaymentMethod?: InputMaybe; + /** + * An ID of the order placed on the originating platform. + * Note that this value doesn't correspond to the Shopify Order ID. + * + */ + sourceIdentifier?: InputMaybe; + /** + * The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay). + * + */ + walletPaymentMethod?: InputMaybe; +}; + +/** Return type for `cartPaymentUpdate` mutation. */ +export type CartPaymentUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** + * The input fields for updating the selected delivery options for a delivery group. + * + */ +export type CartSelectedDeliveryOptionInput = { + /** The ID of the cart delivery group. */ + deliveryGroupId: Scalars['ID']['input']; + /** The handle of the selected delivery option. */ + deliveryOptionHandle: Scalars['String']['input']; +}; + +/** Return type for `cartSelectedDeliveryOptionsUpdate` mutation. */ +export type CartSelectedDeliveryOptionsUpdatePayload = { + /** The updated cart. */ + cart?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `cartSubmitForCompletion` mutation. */ +export type CartSubmitForCompletionPayload = { + /** The result of cart submission for completion. */ + result?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** The result of cart submit completion. */ +export type CartSubmitForCompletionResult = SubmitAlreadyAccepted | SubmitFailed | SubmitSuccess | SubmitThrottled; + +/** Represents an error that happens during execution of a cart mutation. */ +export type CartUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** + * The input fields for submitting wallet payment method information for checkout. + * + */ +export type CartWalletPaymentMethodInput = { + /** The payment method information for the Apple Pay wallet. */ + applePayWalletContent?: InputMaybe; + /** The payment method information for the Shop Pay wallet. */ + shopPayWalletContent?: InputMaybe; +}; + +/** A container for all the information required to checkout items and pay. */ +export type Checkout = Node & { + /** The gift cards used on the checkout. */ + appliedGiftCards: Array; + /** + * The available shipping rates for this Checkout. + * Should only be used when checkout `requiresShipping` is `true` and + * the shipping address is valid. + * + */ + availableShippingRates?: Maybe; + /** The identity of the customer associated with the checkout. */ + buyerIdentity: CheckoutBuyerIdentity; + /** The date and time when the checkout was completed. */ + completedAt?: Maybe; + /** The date and time when the checkout was created. */ + createdAt: Scalars['DateTime']['output']; + /** The currency code for the checkout. */ + currencyCode: CurrencyCode; + /** A list of extra information that's added to the checkout. */ + customAttributes: Array; + /** Discounts that have been applied on the checkout. */ + discountApplications: DiscountApplicationConnection; + /** The email attached to this checkout. */ + email?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** A list of line item objects, each one containing information about an item in the checkout. */ + lineItems: CheckoutLineItemConnection; + /** The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded. */ + lineItemsSubtotalPrice: MoneyV2; + /** The note associated with the checkout. */ + note?: Maybe; + /** The resulting order from a paid checkout. */ + order?: Maybe; + /** The Order Status Page for this Checkout, null when checkout isn't completed. */ + orderStatusUrl?: Maybe; + /** The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards. */ + paymentDue: MoneyV2; + /** + * The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards. + * @deprecated Use `paymentDue` instead. + */ + paymentDueV2: MoneyV2; + /** + * Whether or not the Checkout is ready and can be completed. Checkouts may + * have asynchronous operations that can take time to finish. If you want + * to complete a checkout or ensure all the fields are populated and up to + * date, polling is required until the value is true. + * + */ + ready: Scalars['Boolean']['output']; + /** States whether or not the fulfillment requires shipping. */ + requiresShipping: Scalars['Boolean']['output']; + /** The shipping address to where the line items will be shipped. */ + shippingAddress?: Maybe; + /** + * The discounts that have been allocated onto the shipping line by discount applications. + * + */ + shippingDiscountAllocations: Array; + /** Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object. */ + shippingLine?: Maybe; + /** The price at checkout before shipping and taxes. */ + subtotalPrice: MoneyV2; + /** + * The price at checkout before duties, shipping, and taxes. + * @deprecated Use `subtotalPrice` instead. + */ + subtotalPriceV2: MoneyV2; + /** Whether the checkout is tax exempt. */ + taxExempt: Scalars['Boolean']['output']; + /** Whether taxes are included in the line item and shipping line prices. */ + taxesIncluded: Scalars['Boolean']['output']; + /** The sum of all the duties applied to the line items in the checkout. */ + totalDuties?: Maybe; + /** The sum of all the prices of all the items in the checkout, including taxes and duties. */ + totalPrice: MoneyV2; + /** + * The sum of all the prices of all the items in the checkout, including taxes and duties. + * @deprecated Use `totalPrice` instead. + */ + totalPriceV2: MoneyV2; + /** The sum of all the taxes applied to the line items and shipping lines in the checkout. */ + totalTax: MoneyV2; + /** + * The sum of all the taxes applied to the line items and shipping lines in the checkout. + * @deprecated Use `totalTax` instead. + */ + totalTaxV2: MoneyV2; + /** The date and time when the checkout was last updated. */ + updatedAt: Scalars['DateTime']['output']; + /** The url pointing to the checkout accessible from the web. */ + webUrl: Scalars['URL']['output']; +}; + + +/** A container for all the information required to checkout items and pay. */ +export type CheckoutDiscountApplicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** A container for all the information required to checkout items and pay. */ +export type CheckoutLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** The input fields required to update a checkout's attributes. */ +export type CheckoutAttributesUpdateV2Input = { + /** + * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. + * The required attributes are city, province, and country. + * Full validation of the addresses is still done at completion time. Defaults to `false` with + * each operation. + * + */ + allowPartialAddresses?: InputMaybe; + /** A list of extra information that's added to the checkout. */ + customAttributes?: InputMaybe>; + /** The text of an optional note that a shop owner can attach to the checkout. */ + note?: InputMaybe; +}; + +/** Return type for `checkoutAttributesUpdateV2` mutation. */ +export type CheckoutAttributesUpdateV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** The identity of the customer associated with the checkout. */ +export type CheckoutBuyerIdentity = { + /** The country code for the checkout. For example, `CA`. */ + countryCode?: Maybe; +}; + +/** The input fields for the identity of the customer associated with the checkout. */ +export type CheckoutBuyerIdentityInput = { + /** + * The country code of one of the shop's + * [enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup). + * For example, `CA`. Including this field creates a checkout in the specified country's currency. + * + */ + countryCode: CountryCode; +}; + +/** Return type for `checkoutCompleteFree` mutation. */ +export type CheckoutCompleteFreePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutCompleteWithCreditCardV2` mutation. */ +export type CheckoutCompleteWithCreditCardV2Payload = { + /** The checkout on which the payment was applied. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** A representation of the attempted payment. */ + payment?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutCompleteWithTokenizedPaymentV3` mutation. */ +export type CheckoutCompleteWithTokenizedPaymentV3Payload = { + /** The checkout on which the payment was applied. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** A representation of the attempted payment. */ + payment?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** The input fields required to create a checkout. */ +export type CheckoutCreateInput = { + /** + * Allows setting partial addresses on a Checkout, skipping the full validation of attributes. + * The required attributes are city, province, and country. + * Full validation of addresses is still done at completion time. Defaults to `null`. + * + */ + allowPartialAddresses?: InputMaybe; + /** The identity of the customer associated with the checkout. */ + buyerIdentity?: InputMaybe; + /** A list of extra information that's added to the checkout. */ + customAttributes?: InputMaybe>; + /** The email with which the customer wants to checkout. */ + email?: InputMaybe; + /** A list of line item objects, each one containing information about an item in the checkout. */ + lineItems?: InputMaybe>; + /** The text of an optional note that a shop owner can attach to the checkout. */ + note?: InputMaybe; + /** The shipping address to where the line items will be shipped. */ + shippingAddress?: InputMaybe; +}; + +/** Return type for `checkoutCreate` mutation. */ +export type CheckoutCreatePayload = { + /** The new checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** The checkout queue token. Available only to selected stores. */ + queueToken?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutCustomerAssociateV2` mutation. */ +export type CheckoutCustomerAssociateV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** The associated customer object. */ + customer?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutCustomerDisassociateV2` mutation. */ +export type CheckoutCustomerDisassociateV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutDiscountCodeApplyV2` mutation. */ +export type CheckoutDiscountCodeApplyV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutDiscountCodeRemove` mutation. */ +export type CheckoutDiscountCodeRemovePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutEmailUpdateV2` mutation. */ +export type CheckoutEmailUpdateV2Payload = { + /** The checkout object with the updated email. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `CheckoutUserError`. */ +export type CheckoutErrorCode = + /** Checkout is already completed. */ + | 'ALREADY_COMPLETED' + /** Input email contains an invalid domain name. */ + | 'BAD_DOMAIN' + /** The input value is blank. */ + | 'BLANK' + /** Cart does not meet discount requirements notice. */ + | 'CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE' + /** Customer already used once per customer discount notice. */ + | 'CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE' + /** Discount already applied. */ + | 'DISCOUNT_ALREADY_APPLIED' + /** Discount code isn't working right now. Please contact us for help. */ + | 'DISCOUNT_CODE_APPLICATION_FAILED' + /** Discount disabled. */ + | 'DISCOUNT_DISABLED' + /** Discount expired. */ + | 'DISCOUNT_EXPIRED' + /** Discount limit reached. */ + | 'DISCOUNT_LIMIT_REACHED' + /** Discount not found. */ + | 'DISCOUNT_NOT_FOUND' + /** Checkout is already completed. */ + | 'EMPTY' + /** Queue token has expired. */ + | 'EXPIRED_QUEUE_TOKEN' + /** Gift card has already been applied. */ + | 'GIFT_CARD_ALREADY_APPLIED' + /** Gift card code is invalid. */ + | 'GIFT_CARD_CODE_INVALID' + /** Gift card currency does not match checkout currency. */ + | 'GIFT_CARD_CURRENCY_MISMATCH' + /** Gift card has no funds left. */ + | 'GIFT_CARD_DEPLETED' + /** Gift card is disabled. */ + | 'GIFT_CARD_DISABLED' + /** Gift card is expired. */ + | 'GIFT_CARD_EXPIRED' + /** Gift card was not found. */ + | 'GIFT_CARD_NOT_FOUND' + /** Gift card cannot be applied to a checkout that contains a gift card. */ + | 'GIFT_CARD_UNUSABLE' + /** The input value should be greater than or equal to the minimum value allowed. */ + | 'GREATER_THAN_OR_EQUAL_TO' + /** Higher value discount applied. */ + | 'HIGHER_VALUE_DISCOUNT_APPLIED' + /** The input value is invalid. */ + | 'INVALID' + /** Cannot specify country and presentment currency code. */ + | 'INVALID_COUNTRY_AND_CURRENCY' + /** Input Zip is invalid for country provided. */ + | 'INVALID_FOR_COUNTRY' + /** Input Zip is invalid for country and province provided. */ + | 'INVALID_FOR_COUNTRY_AND_PROVINCE' + /** Invalid province in country. */ + | 'INVALID_PROVINCE_IN_COUNTRY' + /** Queue token is invalid. */ + | 'INVALID_QUEUE_TOKEN' + /** Invalid region in country. */ + | 'INVALID_REGION_IN_COUNTRY' + /** Invalid state in country. */ + | 'INVALID_STATE_IN_COUNTRY' + /** The input value should be less than the maximum value allowed. */ + | 'LESS_THAN' + /** The input value should be less than or equal to the maximum value allowed. */ + | 'LESS_THAN_OR_EQUAL_TO' + /** Line item was not found in checkout. */ + | 'LINE_ITEM_NOT_FOUND' + /** Checkout is locked. */ + | 'LOCKED' + /** Maximum number of discount codes limit reached. */ + | 'MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED' + /** Missing payment input. */ + | 'MISSING_PAYMENT_INPUT' + /** Not enough in stock. */ + | 'NOT_ENOUGH_IN_STOCK' + /** Input value is not supported. */ + | 'NOT_SUPPORTED' + /** The input value needs to be blank. */ + | 'PRESENT' + /** Product is not published for this customer. */ + | 'PRODUCT_NOT_AVAILABLE' + /** Shipping rate expired. */ + | 'SHIPPING_RATE_EXPIRED' + /** Throttled during checkout. */ + | 'THROTTLED_DURING_CHECKOUT' + /** The input value is too long. */ + | 'TOO_LONG' + /** The amount of the payment does not match the value to be paid. */ + | 'TOTAL_PRICE_MISMATCH' + /** Unable to apply discount. */ + | 'UNABLE_TO_APPLY'; + +/** Return type for `checkoutGiftCardRemoveV2` mutation. */ +export type CheckoutGiftCardRemoveV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutGiftCardsAppend` mutation. */ +export type CheckoutGiftCardsAppendPayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** A single line item in the checkout, grouped by variant and attributes. */ +export type CheckoutLineItem = Node & { + /** Extra information in the form of an array of Key-Value pairs about the line item. */ + customAttributes: Array; + /** The discounts that have been allocated onto the checkout line item by discount applications. */ + discountAllocations: Array; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The quantity of the line item. */ + quantity: Scalars['Int']['output']; + /** Title of the line item. Defaults to the product's title. */ + title: Scalars['String']['output']; + /** Unit price of the line item. */ + unitPrice?: Maybe; + /** Product variant of the line item. */ + variant?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple CheckoutLineItems. + * + */ +export type CheckoutLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CheckoutLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one CheckoutLineItem and a cursor during pagination. + * + */ +export type CheckoutLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of CheckoutLineItemEdge. */ + node: CheckoutLineItem; +}; + +/** The input fields to create a line item on a checkout. */ +export type CheckoutLineItemInput = { + /** Extra information in the form of an array of Key-Value pairs about the line item. */ + customAttributes?: InputMaybe>; + /** The quantity of the line item. */ + quantity: Scalars['Int']['input']; + /** The ID of the product variant for the line item. */ + variantId: Scalars['ID']['input']; +}; + +/** The input fields to update a line item on the checkout. */ +export type CheckoutLineItemUpdateInput = { + /** Extra information in the form of an array of Key-Value pairs about the line item. */ + customAttributes?: InputMaybe>; + /** The ID of the line item. */ + id?: InputMaybe; + /** The quantity of the line item. */ + quantity?: InputMaybe; + /** The variant ID of the line item. */ + variantId?: InputMaybe; +}; + +/** Return type for `checkoutLineItemsAdd` mutation. */ +export type CheckoutLineItemsAddPayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutLineItemsRemove` mutation. */ +export type CheckoutLineItemsRemovePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutLineItemsReplace` mutation. */ +export type CheckoutLineItemsReplacePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `checkoutLineItemsUpdate` mutation. */ +export type CheckoutLineItemsUpdatePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutShippingAddressUpdateV2` mutation. */ +export type CheckoutShippingAddressUpdateV2Payload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `checkoutShippingLineUpdate` mutation. */ +export type CheckoutShippingLineUpdatePayload = { + /** The updated checkout object. */ + checkout?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + checkoutUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `checkoutUserErrors` instead. + */ + userErrors: Array; +}; + +/** Represents an error that happens during execution of a checkout mutation. */ +export type CheckoutUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** + * A collection represents a grouping of products that a shop owner can create to + * organize them or make their shops easier to browse. + * + */ +export type Collection = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** Stripped description of the collection, single line with HTML tags removed. */ + description: Scalars['String']['output']; + /** The description of the collection, complete with HTML formatting. */ + descriptionHtml: Scalars['HTML']['output']; + /** + * A human-friendly unique string for the collection automatically generated from its title. + * Limit of 255 characters. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Image associated with the collection. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of products in the collection. */ + products: ProductConnection; + /** The collection's SEO information. */ + seo: Seo; + /** The collection’s name. Limit of 255 characters. */ + title: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** The date and time when the collection was last modified. */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** + * A collection represents a grouping of products that a shop owner can create to + * organize them or make their shops easier to browse. + * + */ +export type CollectionDescriptionArgs = { + truncateAt?: InputMaybe; +}; + + +/** + * A collection represents a grouping of products that a shop owner can create to + * organize them or make their shops easier to browse. + * + */ +export type CollectionMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** + * A collection represents a grouping of products that a shop owner can create to + * organize them or make their shops easier to browse. + * + */ +export type CollectionMetafieldsArgs = { + identifiers: Array; +}; + + +/** + * A collection represents a grouping of products that a shop owner can create to + * organize them or make their shops easier to browse. + * + */ +export type CollectionProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filters?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Collections. + * + */ +export type CollectionConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CollectionEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** The total count of Collections. */ + totalCount: Scalars['UnsignedInt64']['output']; +}; + +/** + * An auto-generated type which holds one Collection and a cursor during pagination. + * + */ +export type CollectionEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of CollectionEdge. */ + node: Collection; +}; + +/** The set of valid sort keys for the Collection query. */ +export type CollectionSortKeys = + /** Sort by the `id` value. */ + | 'ID' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE' + /** Sort by the `updated_at` value. */ + | 'UPDATED_AT'; + +/** A comment on an article. */ +export type Comment = Node & { + /** The comment’s author. */ + author: CommentAuthor; + /** Stripped content of the comment, single line with HTML tags removed. */ + content: Scalars['String']['output']; + /** The content of the comment, complete with HTML formatting. */ + contentHtml: Scalars['HTML']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; +}; + + +/** A comment on an article. */ +export type CommentContentArgs = { + truncateAt?: InputMaybe; +}; + +/** The author of a comment. */ +export type CommentAuthor = { + /** The author's email. */ + email: Scalars['String']['output']; + /** The author’s name. */ + name: Scalars['String']['output']; +}; + +/** + * An auto-generated type for paginating through multiple Comments. + * + */ +export type CommentConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in CommentEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Comment and a cursor during pagination. + * + */ +export type CommentEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of CommentEdge. */ + node: Comment; +}; + +/** The action for the 3DS payment redirect. */ +export type CompletePaymentChallenge = { + /** The URL for the 3DS payment redirect. */ + redirectUrl?: Maybe; +}; + +/** An error that occurred during a cart completion attempt. */ +export type CompletionError = { + /** The error code. */ + code: CompletionErrorCode; + /** The error message. */ + message?: Maybe; +}; + +/** The code of the error that occurred during a cart completion attempt. */ +export type CompletionErrorCode = + | 'ERROR' + | 'INVENTORY_RESERVATION_ERROR' + | 'PAYMENT_AMOUNT_TOO_SMALL' + | 'PAYMENT_CALL_ISSUER' + | 'PAYMENT_CARD_DECLINED' + | 'PAYMENT_ERROR' + | 'PAYMENT_GATEWAY_NOT_ENABLED_ERROR' + | 'PAYMENT_INSUFFICIENT_FUNDS' + | 'PAYMENT_INVALID_BILLING_ADDRESS' + | 'PAYMENT_INVALID_CREDIT_CARD' + | 'PAYMENT_INVALID_CURRENCY' + | 'PAYMENT_INVALID_PAYMENT_METHOD' + | 'PAYMENT_TRANSIENT_ERROR'; + +/** Represents information about the grouped merchandise in the cart. */ +export type ComponentizableCartLine = BaseCartLine & Node & { + /** An attribute associated with the cart line. */ + attribute?: Maybe; + /** The attributes associated with the cart line. Attributes are represented as key-value pairs. */ + attributes: Array; + /** The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout. */ + cost: CartLineCost; + /** The discounts that have been applied to the cart line. */ + discountAllocations: Array; + /** + * The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout. + * @deprecated Use `cost` instead. + */ + estimatedCost: CartLineEstimatedCost; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The components of the line item. */ + lineComponents: Array; + /** The merchandise that the buyer intends to purchase. */ + merchandise: Merchandise; + /** The quantity of the merchandise that the customer intends to purchase. */ + quantity: Scalars['Int']['output']; + /** The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased. */ + sellingPlanAllocation?: Maybe; +}; + + +/** Represents information about the grouped merchandise in the cart. */ +export type ComponentizableCartLineAttributeArgs = { + key: Scalars['String']['input']; +}; + +/** A country. */ +export type Country = { + /** The languages available for the country. */ + availableLanguages: Array; + /** The currency of the country. */ + currency: Currency; + /** The ISO code of the country. */ + isoCode: CountryCode; + /** The market that includes this country. */ + market?: Maybe; + /** The name of the country. */ + name: Scalars['String']['output']; + /** The unit system used in the country. */ + unitSystem: UnitSystem; +}; + +/** + * The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines. + * If a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision + * of another country. For example, the territories associated with Spain are represented by the country code `ES`, + * and the territories associated with the United States of America are represented by the country code `US`. + * + */ +export type CountryCode = + /** Ascension Island. */ + | 'AC' + /** Andorra. */ + | 'AD' + /** United Arab Emirates. */ + | 'AE' + /** Afghanistan. */ + | 'AF' + /** Antigua & Barbuda. */ + | 'AG' + /** Anguilla. */ + | 'AI' + /** Albania. */ + | 'AL' + /** Armenia. */ + | 'AM' + /** Netherlands Antilles. */ + | 'AN' + /** Angola. */ + | 'AO' + /** Argentina. */ + | 'AR' + /** Austria. */ + | 'AT' + /** Australia. */ + | 'AU' + /** Aruba. */ + | 'AW' + /** Åland Islands. */ + | 'AX' + /** Azerbaijan. */ + | 'AZ' + /** Bosnia & Herzegovina. */ + | 'BA' + /** Barbados. */ + | 'BB' + /** Bangladesh. */ + | 'BD' + /** Belgium. */ + | 'BE' + /** Burkina Faso. */ + | 'BF' + /** Bulgaria. */ + | 'BG' + /** Bahrain. */ + | 'BH' + /** Burundi. */ + | 'BI' + /** Benin. */ + | 'BJ' + /** St. Barthélemy. */ + | 'BL' + /** Bermuda. */ + | 'BM' + /** Brunei. */ + | 'BN' + /** Bolivia. */ + | 'BO' + /** Caribbean Netherlands. */ + | 'BQ' + /** Brazil. */ + | 'BR' + /** Bahamas. */ + | 'BS' + /** Bhutan. */ + | 'BT' + /** Bouvet Island. */ + | 'BV' + /** Botswana. */ + | 'BW' + /** Belarus. */ + | 'BY' + /** Belize. */ + | 'BZ' + /** Canada. */ + | 'CA' + /** Cocos (Keeling) Islands. */ + | 'CC' + /** Congo - Kinshasa. */ + | 'CD' + /** Central African Republic. */ + | 'CF' + /** Congo - Brazzaville. */ + | 'CG' + /** Switzerland. */ + | 'CH' + /** Côte d’Ivoire. */ + | 'CI' + /** Cook Islands. */ + | 'CK' + /** Chile. */ + | 'CL' + /** Cameroon. */ + | 'CM' + /** China. */ + | 'CN' + /** Colombia. */ + | 'CO' + /** Costa Rica. */ + | 'CR' + /** Cuba. */ + | 'CU' + /** Cape Verde. */ + | 'CV' + /** Curaçao. */ + | 'CW' + /** Christmas Island. */ + | 'CX' + /** Cyprus. */ + | 'CY' + /** Czechia. */ + | 'CZ' + /** Germany. */ + | 'DE' + /** Djibouti. */ + | 'DJ' + /** Denmark. */ + | 'DK' + /** Dominica. */ + | 'DM' + /** Dominican Republic. */ + | 'DO' + /** Algeria. */ + | 'DZ' + /** Ecuador. */ + | 'EC' + /** Estonia. */ + | 'EE' + /** Egypt. */ + | 'EG' + /** Western Sahara. */ + | 'EH' + /** Eritrea. */ + | 'ER' + /** Spain. */ + | 'ES' + /** Ethiopia. */ + | 'ET' + /** Finland. */ + | 'FI' + /** Fiji. */ + | 'FJ' + /** Falkland Islands. */ + | 'FK' + /** Faroe Islands. */ + | 'FO' + /** France. */ + | 'FR' + /** Gabon. */ + | 'GA' + /** United Kingdom. */ + | 'GB' + /** Grenada. */ + | 'GD' + /** Georgia. */ + | 'GE' + /** French Guiana. */ + | 'GF' + /** Guernsey. */ + | 'GG' + /** Ghana. */ + | 'GH' + /** Gibraltar. */ + | 'GI' + /** Greenland. */ + | 'GL' + /** Gambia. */ + | 'GM' + /** Guinea. */ + | 'GN' + /** Guadeloupe. */ + | 'GP' + /** Equatorial Guinea. */ + | 'GQ' + /** Greece. */ + | 'GR' + /** South Georgia & South Sandwich Islands. */ + | 'GS' + /** Guatemala. */ + | 'GT' + /** Guinea-Bissau. */ + | 'GW' + /** Guyana. */ + | 'GY' + /** Hong Kong SAR. */ + | 'HK' + /** Heard & McDonald Islands. */ + | 'HM' + /** Honduras. */ + | 'HN' + /** Croatia. */ + | 'HR' + /** Haiti. */ + | 'HT' + /** Hungary. */ + | 'HU' + /** Indonesia. */ + | 'ID' + /** Ireland. */ + | 'IE' + /** Israel. */ + | 'IL' + /** Isle of Man. */ + | 'IM' + /** India. */ + | 'IN' + /** British Indian Ocean Territory. */ + | 'IO' + /** Iraq. */ + | 'IQ' + /** Iran. */ + | 'IR' + /** Iceland. */ + | 'IS' + /** Italy. */ + | 'IT' + /** Jersey. */ + | 'JE' + /** Jamaica. */ + | 'JM' + /** Jordan. */ + | 'JO' + /** Japan. */ + | 'JP' + /** Kenya. */ + | 'KE' + /** Kyrgyzstan. */ + | 'KG' + /** Cambodia. */ + | 'KH' + /** Kiribati. */ + | 'KI' + /** Comoros. */ + | 'KM' + /** St. Kitts & Nevis. */ + | 'KN' + /** North Korea. */ + | 'KP' + /** South Korea. */ + | 'KR' + /** Kuwait. */ + | 'KW' + /** Cayman Islands. */ + | 'KY' + /** Kazakhstan. */ + | 'KZ' + /** Laos. */ + | 'LA' + /** Lebanon. */ + | 'LB' + /** St. Lucia. */ + | 'LC' + /** Liechtenstein. */ + | 'LI' + /** Sri Lanka. */ + | 'LK' + /** Liberia. */ + | 'LR' + /** Lesotho. */ + | 'LS' + /** Lithuania. */ + | 'LT' + /** Luxembourg. */ + | 'LU' + /** Latvia. */ + | 'LV' + /** Libya. */ + | 'LY' + /** Morocco. */ + | 'MA' + /** Monaco. */ + | 'MC' + /** Moldova. */ + | 'MD' + /** Montenegro. */ + | 'ME' + /** St. Martin. */ + | 'MF' + /** Madagascar. */ + | 'MG' + /** North Macedonia. */ + | 'MK' + /** Mali. */ + | 'ML' + /** Myanmar (Burma). */ + | 'MM' + /** Mongolia. */ + | 'MN' + /** Macao SAR. */ + | 'MO' + /** Martinique. */ + | 'MQ' + /** Mauritania. */ + | 'MR' + /** Montserrat. */ + | 'MS' + /** Malta. */ + | 'MT' + /** Mauritius. */ + | 'MU' + /** Maldives. */ + | 'MV' + /** Malawi. */ + | 'MW' + /** Mexico. */ + | 'MX' + /** Malaysia. */ + | 'MY' + /** Mozambique. */ + | 'MZ' + /** Namibia. */ + | 'NA' + /** New Caledonia. */ + | 'NC' + /** Niger. */ + | 'NE' + /** Norfolk Island. */ + | 'NF' + /** Nigeria. */ + | 'NG' + /** Nicaragua. */ + | 'NI' + /** Netherlands. */ + | 'NL' + /** Norway. */ + | 'NO' + /** Nepal. */ + | 'NP' + /** Nauru. */ + | 'NR' + /** Niue. */ + | 'NU' + /** New Zealand. */ + | 'NZ' + /** Oman. */ + | 'OM' + /** Panama. */ + | 'PA' + /** Peru. */ + | 'PE' + /** French Polynesia. */ + | 'PF' + /** Papua New Guinea. */ + | 'PG' + /** Philippines. */ + | 'PH' + /** Pakistan. */ + | 'PK' + /** Poland. */ + | 'PL' + /** St. Pierre & Miquelon. */ + | 'PM' + /** Pitcairn Islands. */ + | 'PN' + /** Palestinian Territories. */ + | 'PS' + /** Portugal. */ + | 'PT' + /** Paraguay. */ + | 'PY' + /** Qatar. */ + | 'QA' + /** Réunion. */ + | 'RE' + /** Romania. */ + | 'RO' + /** Serbia. */ + | 'RS' + /** Russia. */ + | 'RU' + /** Rwanda. */ + | 'RW' + /** Saudi Arabia. */ + | 'SA' + /** Solomon Islands. */ + | 'SB' + /** Seychelles. */ + | 'SC' + /** Sudan. */ + | 'SD' + /** Sweden. */ + | 'SE' + /** Singapore. */ + | 'SG' + /** St. Helena. */ + | 'SH' + /** Slovenia. */ + | 'SI' + /** Svalbard & Jan Mayen. */ + | 'SJ' + /** Slovakia. */ + | 'SK' + /** Sierra Leone. */ + | 'SL' + /** San Marino. */ + | 'SM' + /** Senegal. */ + | 'SN' + /** Somalia. */ + | 'SO' + /** Suriname. */ + | 'SR' + /** South Sudan. */ + | 'SS' + /** São Tomé & Príncipe. */ + | 'ST' + /** El Salvador. */ + | 'SV' + /** Sint Maarten. */ + | 'SX' + /** Syria. */ + | 'SY' + /** Eswatini. */ + | 'SZ' + /** Tristan da Cunha. */ + | 'TA' + /** Turks & Caicos Islands. */ + | 'TC' + /** Chad. */ + | 'TD' + /** French Southern Territories. */ + | 'TF' + /** Togo. */ + | 'TG' + /** Thailand. */ + | 'TH' + /** Tajikistan. */ + | 'TJ' + /** Tokelau. */ + | 'TK' + /** Timor-Leste. */ + | 'TL' + /** Turkmenistan. */ + | 'TM' + /** Tunisia. */ + | 'TN' + /** Tonga. */ + | 'TO' + /** Turkey. */ + | 'TR' + /** Trinidad & Tobago. */ + | 'TT' + /** Tuvalu. */ + | 'TV' + /** Taiwan. */ + | 'TW' + /** Tanzania. */ + | 'TZ' + /** Ukraine. */ + | 'UA' + /** Uganda. */ + | 'UG' + /** U.S. Outlying Islands. */ + | 'UM' + /** United States. */ + | 'US' + /** Uruguay. */ + | 'UY' + /** Uzbekistan. */ + | 'UZ' + /** Vatican City. */ + | 'VA' + /** St. Vincent & Grenadines. */ + | 'VC' + /** Venezuela. */ + | 'VE' + /** British Virgin Islands. */ + | 'VG' + /** Vietnam. */ + | 'VN' + /** Vanuatu. */ + | 'VU' + /** Wallis & Futuna. */ + | 'WF' + /** Samoa. */ + | 'WS' + /** Kosovo. */ + | 'XK' + /** Yemen. */ + | 'YE' + /** Mayotte. */ + | 'YT' + /** South Africa. */ + | 'ZA' + /** Zambia. */ + | 'ZM' + /** Zimbabwe. */ + | 'ZW' + /** Unknown Region. */ + | 'ZZ'; + +/** Credit card information used for a payment. */ +export type CreditCard = { + /** The brand of the credit card. */ + brand?: Maybe; + /** The expiry month of the credit card. */ + expiryMonth?: Maybe; + /** The expiry year of the credit card. */ + expiryYear?: Maybe; + /** The credit card's BIN number. */ + firstDigits?: Maybe; + /** The first name of the card holder. */ + firstName?: Maybe; + /** The last 4 digits of the credit card. */ + lastDigits?: Maybe; + /** The last name of the card holder. */ + lastName?: Maybe; + /** The masked credit card number with only the last 4 digits displayed. */ + maskedNumber?: Maybe; +}; + +/** + * Specifies the fields required to complete a checkout with + * a Shopify vaulted credit card payment. + * + */ +export type CreditCardPaymentInputV2 = { + /** The billing address for the payment. */ + billingAddress: MailingAddressInput; + /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ + idempotencyKey: Scalars['String']['input']; + /** The amount and currency of the payment. */ + paymentAmount: MoneyInput; + /** Executes the payment in test mode if possible. Defaults to `false`. */ + test?: InputMaybe; + /** The ID returned by Shopify's Card Vault. */ + vaultId: Scalars['String']['input']; +}; + +/** The part of the image that should remain after cropping. */ +export type CropRegion = + /** Keep the bottom of the image. */ + | 'BOTTOM' + /** Keep the center of the image. */ + | 'CENTER' + /** Keep the left of the image. */ + | 'LEFT' + /** Keep the right of the image. */ + | 'RIGHT' + /** Keep the top of the image. */ + | 'TOP'; + +/** A currency. */ +export type Currency = { + /** The ISO code of the currency. */ + isoCode: CurrencyCode; + /** The name of the currency. */ + name: Scalars['String']['output']; + /** The symbol of the currency. */ + symbol: Scalars['String']['output']; +}; + +/** + * The three-letter currency codes that represent the world currencies used in + * stores. These include standard ISO 4217 codes, legacy codes, + * and non-standard codes. + * + */ +export type CurrencyCode = + /** United Arab Emirates Dirham (AED). */ + | 'AED' + /** Afghan Afghani (AFN). */ + | 'AFN' + /** Albanian Lek (ALL). */ + | 'ALL' + /** Armenian Dram (AMD). */ + | 'AMD' + /** Netherlands Antillean Guilder. */ + | 'ANG' + /** Angolan Kwanza (AOA). */ + | 'AOA' + /** Argentine Pesos (ARS). */ + | 'ARS' + /** Australian Dollars (AUD). */ + | 'AUD' + /** Aruban Florin (AWG). */ + | 'AWG' + /** Azerbaijani Manat (AZN). */ + | 'AZN' + /** Bosnia and Herzegovina Convertible Mark (BAM). */ + | 'BAM' + /** Barbadian Dollar (BBD). */ + | 'BBD' + /** Bangladesh Taka (BDT). */ + | 'BDT' + /** Bulgarian Lev (BGN). */ + | 'BGN' + /** Bahraini Dinar (BHD). */ + | 'BHD' + /** Burundian Franc (BIF). */ + | 'BIF' + /** Bermudian Dollar (BMD). */ + | 'BMD' + /** Brunei Dollar (BND). */ + | 'BND' + /** Bolivian Boliviano (BOB). */ + | 'BOB' + /** Brazilian Real (BRL). */ + | 'BRL' + /** Bahamian Dollar (BSD). */ + | 'BSD' + /** Bhutanese Ngultrum (BTN). */ + | 'BTN' + /** Botswana Pula (BWP). */ + | 'BWP' + /** Belarusian Ruble (BYN). */ + | 'BYN' + /** Belarusian Ruble (BYR). */ + | 'BYR' + /** Belize Dollar (BZD). */ + | 'BZD' + /** Canadian Dollars (CAD). */ + | 'CAD' + /** Congolese franc (CDF). */ + | 'CDF' + /** Swiss Francs (CHF). */ + | 'CHF' + /** Chilean Peso (CLP). */ + | 'CLP' + /** Chinese Yuan Renminbi (CNY). */ + | 'CNY' + /** Colombian Peso (COP). */ + | 'COP' + /** Costa Rican Colones (CRC). */ + | 'CRC' + /** Cape Verdean escudo (CVE). */ + | 'CVE' + /** Czech Koruny (CZK). */ + | 'CZK' + /** Djiboutian Franc (DJF). */ + | 'DJF' + /** Danish Kroner (DKK). */ + | 'DKK' + /** Dominican Peso (DOP). */ + | 'DOP' + /** Algerian Dinar (DZD). */ + | 'DZD' + /** Egyptian Pound (EGP). */ + | 'EGP' + /** Eritrean Nakfa (ERN). */ + | 'ERN' + /** Ethiopian Birr (ETB). */ + | 'ETB' + /** Euro (EUR). */ + | 'EUR' + /** Fijian Dollars (FJD). */ + | 'FJD' + /** Falkland Islands Pounds (FKP). */ + | 'FKP' + /** United Kingdom Pounds (GBP). */ + | 'GBP' + /** Georgian Lari (GEL). */ + | 'GEL' + /** Ghanaian Cedi (GHS). */ + | 'GHS' + /** Gibraltar Pounds (GIP). */ + | 'GIP' + /** Gambian Dalasi (GMD). */ + | 'GMD' + /** Guinean Franc (GNF). */ + | 'GNF' + /** Guatemalan Quetzal (GTQ). */ + | 'GTQ' + /** Guyanese Dollar (GYD). */ + | 'GYD' + /** Hong Kong Dollars (HKD). */ + | 'HKD' + /** Honduran Lempira (HNL). */ + | 'HNL' + /** Croatian Kuna (HRK). */ + | 'HRK' + /** Haitian Gourde (HTG). */ + | 'HTG' + /** Hungarian Forint (HUF). */ + | 'HUF' + /** Indonesian Rupiah (IDR). */ + | 'IDR' + /** Israeli New Shekel (NIS). */ + | 'ILS' + /** Indian Rupees (INR). */ + | 'INR' + /** Iraqi Dinar (IQD). */ + | 'IQD' + /** Iranian Rial (IRR). */ + | 'IRR' + /** Icelandic Kronur (ISK). */ + | 'ISK' + /** Jersey Pound. */ + | 'JEP' + /** Jamaican Dollars (JMD). */ + | 'JMD' + /** Jordanian Dinar (JOD). */ + | 'JOD' + /** Japanese Yen (JPY). */ + | 'JPY' + /** Kenyan Shilling (KES). */ + | 'KES' + /** Kyrgyzstani Som (KGS). */ + | 'KGS' + /** Cambodian Riel. */ + | 'KHR' + /** Kiribati Dollar (KID). */ + | 'KID' + /** Comorian Franc (KMF). */ + | 'KMF' + /** South Korean Won (KRW). */ + | 'KRW' + /** Kuwaiti Dinar (KWD). */ + | 'KWD' + /** Cayman Dollars (KYD). */ + | 'KYD' + /** Kazakhstani Tenge (KZT). */ + | 'KZT' + /** Laotian Kip (LAK). */ + | 'LAK' + /** Lebanese Pounds (LBP). */ + | 'LBP' + /** Sri Lankan Rupees (LKR). */ + | 'LKR' + /** Liberian Dollar (LRD). */ + | 'LRD' + /** Lesotho Loti (LSL). */ + | 'LSL' + /** Lithuanian Litai (LTL). */ + | 'LTL' + /** Latvian Lati (LVL). */ + | 'LVL' + /** Libyan Dinar (LYD). */ + | 'LYD' + /** Moroccan Dirham. */ + | 'MAD' + /** Moldovan Leu (MDL). */ + | 'MDL' + /** Malagasy Ariary (MGA). */ + | 'MGA' + /** Macedonia Denar (MKD). */ + | 'MKD' + /** Burmese Kyat (MMK). */ + | 'MMK' + /** Mongolian Tugrik. */ + | 'MNT' + /** Macanese Pataca (MOP). */ + | 'MOP' + /** Mauritanian Ouguiya (MRU). */ + | 'MRU' + /** Mauritian Rupee (MUR). */ + | 'MUR' + /** Maldivian Rufiyaa (MVR). */ + | 'MVR' + /** Malawian Kwacha (MWK). */ + | 'MWK' + /** Mexican Pesos (MXN). */ + | 'MXN' + /** Malaysian Ringgits (MYR). */ + | 'MYR' + /** Mozambican Metical. */ + | 'MZN' + /** Namibian Dollar. */ + | 'NAD' + /** Nigerian Naira (NGN). */ + | 'NGN' + /** Nicaraguan Córdoba (NIO). */ + | 'NIO' + /** Norwegian Kroner (NOK). */ + | 'NOK' + /** Nepalese Rupee (NPR). */ + | 'NPR' + /** New Zealand Dollars (NZD). */ + | 'NZD' + /** Omani Rial (OMR). */ + | 'OMR' + /** Panamian Balboa (PAB). */ + | 'PAB' + /** Peruvian Nuevo Sol (PEN). */ + | 'PEN' + /** Papua New Guinean Kina (PGK). */ + | 'PGK' + /** Philippine Peso (PHP). */ + | 'PHP' + /** Pakistani Rupee (PKR). */ + | 'PKR' + /** Polish Zlotych (PLN). */ + | 'PLN' + /** Paraguayan Guarani (PYG). */ + | 'PYG' + /** Qatari Rial (QAR). */ + | 'QAR' + /** Romanian Lei (RON). */ + | 'RON' + /** Serbian dinar (RSD). */ + | 'RSD' + /** Russian Rubles (RUB). */ + | 'RUB' + /** Rwandan Franc (RWF). */ + | 'RWF' + /** Saudi Riyal (SAR). */ + | 'SAR' + /** Solomon Islands Dollar (SBD). */ + | 'SBD' + /** Seychellois Rupee (SCR). */ + | 'SCR' + /** Sudanese Pound (SDG). */ + | 'SDG' + /** Swedish Kronor (SEK). */ + | 'SEK' + /** Singapore Dollars (SGD). */ + | 'SGD' + /** Saint Helena Pounds (SHP). */ + | 'SHP' + /** Sierra Leonean Leone (SLL). */ + | 'SLL' + /** Somali Shilling (SOS). */ + | 'SOS' + /** Surinamese Dollar (SRD). */ + | 'SRD' + /** South Sudanese Pound (SSP). */ + | 'SSP' + /** Sao Tome And Principe Dobra (STD). */ + | 'STD' + /** Sao Tome And Principe Dobra (STN). */ + | 'STN' + /** Syrian Pound (SYP). */ + | 'SYP' + /** Swazi Lilangeni (SZL). */ + | 'SZL' + /** Thai baht (THB). */ + | 'THB' + /** Tajikistani Somoni (TJS). */ + | 'TJS' + /** Turkmenistani Manat (TMT). */ + | 'TMT' + /** Tunisian Dinar (TND). */ + | 'TND' + /** Tongan Pa'anga (TOP). */ + | 'TOP' + /** Turkish Lira (TRY). */ + | 'TRY' + /** Trinidad and Tobago Dollars (TTD). */ + | 'TTD' + /** Taiwan Dollars (TWD). */ + | 'TWD' + /** Tanzanian Shilling (TZS). */ + | 'TZS' + /** Ukrainian Hryvnia (UAH). */ + | 'UAH' + /** Ugandan Shilling (UGX). */ + | 'UGX' + /** United States Dollars (USD). */ + | 'USD' + /** Uruguayan Pesos (UYU). */ + | 'UYU' + /** Uzbekistan som (UZS). */ + | 'UZS' + /** Venezuelan Bolivares (VED). */ + | 'VED' + /** Venezuelan Bolivares (VEF). */ + | 'VEF' + /** Venezuelan Bolivares (VES). */ + | 'VES' + /** Vietnamese đồng (VND). */ + | 'VND' + /** Vanuatu Vatu (VUV). */ + | 'VUV' + /** Samoan Tala (WST). */ + | 'WST' + /** Central African CFA Franc (XAF). */ + | 'XAF' + /** East Caribbean Dollar (XCD). */ + | 'XCD' + /** West African CFA franc (XOF). */ + | 'XOF' + /** CFP Franc (XPF). */ + | 'XPF' + /** Unrecognized currency. */ + | 'XXX' + /** Yemeni Rial (YER). */ + | 'YER' + /** South African Rand (ZAR). */ + | 'ZAR' + /** Zambian Kwacha (ZMW). */ + | 'ZMW'; + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type Customer = HasMetafields & { + /** Indicates whether the customer has consented to be sent marketing material via email. */ + acceptsMarketing: Scalars['Boolean']['output']; + /** A list of addresses for the customer. */ + addresses: MailingAddressConnection; + /** The date and time when the customer was created. */ + createdAt: Scalars['DateTime']['output']; + /** The customer’s default address. */ + defaultAddress?: Maybe; + /** The customer’s name, email or phone number. */ + displayName: Scalars['String']['output']; + /** The customer’s email address. */ + email?: Maybe; + /** The customer’s first name. */ + firstName?: Maybe; + /** A unique ID for the customer. */ + id: Scalars['ID']['output']; + /** The customer's most recently updated, incomplete checkout. */ + lastIncompleteCheckout?: Maybe; + /** The customer’s last name. */ + lastName?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The number of orders that the customer has made at the store in their lifetime. */ + numberOfOrders: Scalars['UnsignedInt64']['output']; + /** The orders associated with the customer. */ + orders: OrderConnection; + /** The customer’s phone number. */ + phone?: Maybe; + /** + * A comma separated list of tags that have been added to the customer. + * Additional access scope required: unauthenticated_read_customer_tags. + * + */ + tags: Array; + /** The date and time when the customer information was updated. */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerAddressesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerMetafieldsArgs = { + identifiers: Array; +}; + + +/** A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout. */ +export type CustomerOrdersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A CustomerAccessToken represents the unique token required to make modifications to the customer object. */ +export type CustomerAccessToken = { + /** The customer’s access token. */ + accessToken: Scalars['String']['output']; + /** The date and time when the customer access token expires. */ + expiresAt: Scalars['DateTime']['output']; +}; + +/** The input fields required to create a customer access token. */ +export type CustomerAccessTokenCreateInput = { + /** The email associated to the customer. */ + email: Scalars['String']['input']; + /** The login password to be used by the customer. */ + password: Scalars['String']['input']; +}; + +/** Return type for `customerAccessTokenCreate` mutation. */ +export type CustomerAccessTokenCreatePayload = { + /** The newly created customer access token object. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerAccessTokenCreateWithMultipass` mutation. */ +export type CustomerAccessTokenCreateWithMultipassPayload = { + /** An access token object associated with the customer. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; +}; + +/** Return type for `customerAccessTokenDelete` mutation. */ +export type CustomerAccessTokenDeletePayload = { + /** The destroyed access token. */ + deletedAccessToken?: Maybe; + /** ID of the destroyed customer access token. */ + deletedCustomerAccessTokenId?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerAccessTokenRenew` mutation. */ +export type CustomerAccessTokenRenewPayload = { + /** The renewed customer access token object. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + userErrors: Array; +}; + +/** Return type for `customerActivateByUrl` mutation. */ +export type CustomerActivateByUrlPayload = { + /** The customer that was activated. */ + customer?: Maybe; + /** A new customer access token for the customer. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; +}; + +/** The input fields to activate a customer. */ +export type CustomerActivateInput = { + /** The activation token required to activate the customer. */ + activationToken: Scalars['String']['input']; + /** New password that will be set during activation. */ + password: Scalars['String']['input']; +}; + +/** Return type for `customerActivate` mutation. */ +export type CustomerActivatePayload = { + /** The customer object. */ + customer?: Maybe; + /** A newly created customer access token object for the customer. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerAddressCreate` mutation. */ +export type CustomerAddressCreatePayload = { + /** The new customer address object. */ + customerAddress?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerAddressDelete` mutation. */ +export type CustomerAddressDeletePayload = { + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** ID of the deleted customer address. */ + deletedCustomerAddressId?: Maybe; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerAddressUpdate` mutation. */ +export type CustomerAddressUpdatePayload = { + /** The customer’s updated mailing address. */ + customerAddress?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** The input fields to create a new customer. */ +export type CustomerCreateInput = { + /** Indicates whether the customer has consented to be sent marketing material via email. */ + acceptsMarketing?: InputMaybe; + /** The customer’s email. */ + email: Scalars['String']['input']; + /** The customer’s first name. */ + firstName?: InputMaybe; + /** The customer’s last name. */ + lastName?: InputMaybe; + /** The login password used by the customer. */ + password: Scalars['String']['input']; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. + * + */ + phone?: InputMaybe; +}; + +/** Return type for `customerCreate` mutation. */ +export type CustomerCreatePayload = { + /** The created customer object. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerDefaultAddressUpdate` mutation. */ +export type CustomerDefaultAddressUpdatePayload = { + /** The updated customer object. */ + customer?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Possible error codes that can be returned by `CustomerUserError`. */ +export type CustomerErrorCode = + /** Customer already enabled. */ + | 'ALREADY_ENABLED' + /** Input email contains an invalid domain name. */ + | 'BAD_DOMAIN' + /** The input value is blank. */ + | 'BLANK' + /** Input contains HTML tags. */ + | 'CONTAINS_HTML_TAGS' + /** Input contains URL. */ + | 'CONTAINS_URL' + /** Customer is disabled. */ + | 'CUSTOMER_DISABLED' + /** The input value is invalid. */ + | 'INVALID' + /** Multipass token is not valid. */ + | 'INVALID_MULTIPASS_REQUEST' + /** Address does not exist. */ + | 'NOT_FOUND' + /** Input password starts or ends with whitespace. */ + | 'PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE' + /** The input value is already taken. */ + | 'TAKEN' + /** Invalid activation token. */ + | 'TOKEN_INVALID' + /** The input value is too long. */ + | 'TOO_LONG' + /** The input value is too short. */ + | 'TOO_SHORT' + /** Unidentified customer. */ + | 'UNIDENTIFIED_CUSTOMER'; + +/** Return type for `customerRecover` mutation. */ +export type CustomerRecoverPayload = { + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Return type for `customerResetByUrl` mutation. */ +export type CustomerResetByUrlPayload = { + /** The customer object which was reset. */ + customer?: Maybe; + /** A newly created customer access token object for the customer. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** The input fields to reset a customer's password. */ +export type CustomerResetInput = { + /** New password that will be set as part of the reset password process. */ + password: Scalars['String']['input']; + /** The reset token required to reset the customer’s password. */ + resetToken: Scalars['String']['input']; +}; + +/** Return type for `customerReset` mutation. */ +export type CustomerResetPayload = { + /** The customer object which was reset. */ + customer?: Maybe; + /** A newly created customer access token object for the customer. */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** The input fields to update the Customer information. */ +export type CustomerUpdateInput = { + /** Indicates whether the customer has consented to be sent marketing material via email. */ + acceptsMarketing?: InputMaybe; + /** The customer’s email. */ + email?: InputMaybe; + /** The customer’s first name. */ + firstName?: InputMaybe; + /** The customer’s last name. */ + lastName?: InputMaybe; + /** The login password used by the customer. */ + password?: InputMaybe; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`. + * + */ + phone?: InputMaybe; +}; + +/** Return type for `customerUpdate` mutation. */ +export type CustomerUpdatePayload = { + /** The updated customer object. */ + customer?: Maybe; + /** + * The newly created customer access token. If the customer's password is updated, all previous access tokens + * (including the one used to perform this mutation) become invalid, and a new token is generated. + * + */ + customerAccessToken?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + customerUserErrors: Array; + /** + * The list of errors that occurred from executing the mutation. + * @deprecated Use `customerUserErrors` instead. + */ + userErrors: Array; +}; + +/** Represents an error that happens during execution of a customer mutation. */ +export type CustomerUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** A delivery address of the buyer that is interacting with the cart. */ +export type DeliveryAddress = MailingAddress; + +/** + * The input fields for delivery address preferences. + * + */ +export type DeliveryAddressInput = { + /** + * The ID of a customer address that is associated with the buyer that is interacting with the cart. + * + */ + customerAddressId?: InputMaybe; + /** A delivery address preference of a buyer that is interacting with the cart. */ + deliveryAddress?: InputMaybe; +}; + +/** List of different delivery method types. */ +export type DeliveryMethodType = + /** Local Delivery. */ + | 'LOCAL' + /** None. */ + | 'NONE' + /** Shipping to a Pickup Point. */ + | 'PICKUP_POINT' + /** Local Pickup. */ + | 'PICK_UP' + /** Retail. */ + | 'RETAIL' + /** Shipping. */ + | 'SHIPPING'; + +/** Digital wallet, such as Apple Pay, which can be used for accelerated checkouts. */ +export type DigitalWallet = + /** Android Pay. */ + | 'ANDROID_PAY' + /** Apple Pay. */ + | 'APPLE_PAY' + /** Google Pay. */ + | 'GOOGLE_PAY' + /** Shopify Pay. */ + | 'SHOPIFY_PAY'; + +/** + * An amount discounting the line that has been allocated by a discount. + * + */ +export type DiscountAllocation = { + /** Amount of discount allocated. */ + allocatedAmount: MoneyV2; + /** The discount this allocated amount originated from. */ + discountApplication: DiscountApplication; +}; + +/** + * Discount applications capture the intentions of a discount source at + * the time of application. + * + */ +export type DiscountApplication = { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** Which lines of targetType that the discount is allocated over. */ + targetSelection: DiscountApplicationTargetSelection; + /** The type of line that the discount is applicable towards. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** The method by which the discount's value is allocated onto its entitled lines. */ +export type DiscountApplicationAllocationMethod = + /** The value is spread across all entitled lines. */ + | 'ACROSS' + /** The value is applied onto every entitled line. */ + | 'EACH' + /** The value is specifically applied onto a particular line. */ + | 'ONE'; + +/** + * An auto-generated type for paginating through multiple DiscountApplications. + * + */ +export type DiscountApplicationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in DiscountApplicationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one DiscountApplication and a cursor during pagination. + * + */ +export type DiscountApplicationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of DiscountApplicationEdge. */ + node: DiscountApplication; +}; + +/** + * The lines on the order to which the discount is applied, of the type defined by + * the discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of + * `LINE_ITEM`, applies the discount on all line items that are entitled to the discount. + * The value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines. + * + */ +export type DiscountApplicationTargetSelection = + /** The discount is allocated onto all the lines. */ + | 'ALL' + /** The discount is allocated onto only the lines that it's entitled for. */ + | 'ENTITLED' + /** The discount is allocated onto explicitly chosen lines. */ + | 'EXPLICIT'; + +/** + * The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards. + * + */ +export type DiscountApplicationTargetType = + /** The discount applies onto line items. */ + | 'LINE_ITEM' + /** The discount applies onto shipping lines. */ + | 'SHIPPING_LINE'; + +/** + * Discount code applications capture the intentions of a discount code at + * the time that it is applied. + * + */ +export type DiscountCodeApplication = DiscountApplication & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** Specifies whether the discount code was applied successfully. */ + applicable: Scalars['Boolean']['output']; + /** The string identifying the discount code that was used at the time of application. */ + code: Scalars['String']['output']; + /** Which lines of targetType that the discount is allocated over. */ + targetSelection: DiscountApplicationTargetSelection; + /** The type of line that the discount is applicable towards. */ + targetType: DiscountApplicationTargetType; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** Represents an error in the input of a mutation. */ +export type DisplayableError = { + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** Represents a web address. */ +export type Domain = { + /** The host name of the domain (eg: `example.com`). */ + host: Scalars['String']['output']; + /** Whether SSL is enabled or not. */ + sslEnabled: Scalars['Boolean']['output']; + /** The URL of the domain (eg: `https://example.com`). */ + url: Scalars['URL']['output']; +}; + +/** Represents a video hosted outside of Shopify. */ +export type ExternalVideo = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** The embed URL of the video for the respective host. */ + embedUrl: Scalars['URL']['output']; + /** + * The URL. + * @deprecated Use `originUrl` instead. + */ + embeddedUrl: Scalars['URL']['output']; + /** The host of the external video. */ + host: MediaHost; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The origin URL of the video on the respective host. */ + originUrl: Scalars['URL']['output']; + /** The presentation for a media. */ + presentation?: Maybe; + /** The preview image for the media. */ + previewImage?: Maybe; +}; + +/** A filter that is supported on the parent field. */ +export type Filter = { + /** A unique identifier. */ + id: Scalars['String']['output']; + /** A human-friendly string for this filter. */ + label: Scalars['String']['output']; + /** An enumeration that denotes the type of data this filter represents. */ + type: FilterType; + /** The list of values for this filter. */ + values: Array; +}; + +/** + * The type of data that the filter group represents. + * + * For more information, refer to [Filter products in a collection with the Storefront API] + * (https://shopify.dev/custom-storefronts/products-collections/filter-products). + * + */ +export type FilterType = + /** A boolean value. */ + | 'BOOLEAN' + /** A list of selectable values. */ + | 'LIST' + /** A range of prices. */ + | 'PRICE_RANGE'; + +/** A selectable value within a filter. */ +export type FilterValue = { + /** The number of results that match this filter value. */ + count: Scalars['Int']['output']; + /** A unique identifier. */ + id: Scalars['String']['output']; + /** + * An input object that can be used to filter by this value on the parent field. + * + * The value is provided as a helper for building dynamic filtering UI. For + * example, if you have a list of selected `FilterValue` objects, you can combine + * their respective `input` values to use in a subsequent query. + * + */ + input: Scalars['JSON']['output']; + /** A human-friendly string for this filter value. */ + label: Scalars['String']['output']; +}; + +/** Represents a single fulfillment in an order. */ +export type Fulfillment = { + /** List of the fulfillment's line items. */ + fulfillmentLineItems: FulfillmentLineItemConnection; + /** The name of the tracking company. */ + trackingCompany?: Maybe; + /** + * Tracking information associated with the fulfillment, + * such as the tracking number and tracking URL. + * + */ + trackingInfo: Array; +}; + + +/** Represents a single fulfillment in an order. */ +export type FulfillmentFulfillmentLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** Represents a single fulfillment in an order. */ +export type FulfillmentTrackingInfoArgs = { + first?: InputMaybe; +}; + +/** Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item. */ +export type FulfillmentLineItem = { + /** The associated order's line item. */ + lineItem: OrderLineItem; + /** The amount fulfilled in this fulfillment. */ + quantity: Scalars['Int']['output']; +}; + +/** + * An auto-generated type for paginating through multiple FulfillmentLineItems. + * + */ +export type FulfillmentLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in FulfillmentLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination. + * + */ +export type FulfillmentLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of FulfillmentLineItemEdge. */ + node: FulfillmentLineItem; +}; + +/** Tracking information associated with the fulfillment. */ +export type FulfillmentTrackingInfo = { + /** The tracking number of the fulfillment. */ + number?: Maybe; + /** The URL to track the fulfillment. */ + url?: Maybe; +}; + +/** The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON. */ +export type GenericFile = Node & { + /** A word or phrase to indicate the contents of a file. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The MIME type of the file. */ + mimeType?: Maybe; + /** The size of the original file in bytes. */ + originalFileSize?: Maybe; + /** The preview image for the file. */ + previewImage?: Maybe; + /** The URL of the file. */ + url?: Maybe; +}; + +/** The input fields used to specify a geographical location. */ +export type GeoCoordinateInput = { + /** The coordinate's latitude value. */ + latitude: Scalars['Float']['input']; + /** The coordinate's longitude value. */ + longitude: Scalars['Float']['input']; +}; + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafields = { + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; +}; + + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** Represents information about the metafields associated to the specified resource. */ +export type HasMetafieldsMetafieldsArgs = { + identifiers: Array; +}; + +/** The input fields to identify a metafield on an owner resource by namespace and key. */ +export type HasMetafieldsIdentifier = { + /** The identifier for the metafield. */ + key: Scalars['String']['input']; + /** The container the metafield belongs to. */ + namespace: Scalars['String']['input']; +}; + +/** Represents an image resource. */ +export type Image = { + /** A word or phrase to share the nature or contents of an image. */ + altText?: Maybe; + /** The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ + height?: Maybe; + /** A unique ID for the image. */ + id?: Maybe; + /** + * The location of the original image as a URL. + * + * If there are any existing transformations in the original source URL, they will remain and not be stripped. + * + * @deprecated Use `url` instead. + */ + originalSrc: Scalars['URL']['output']; + /** + * The location of the image as a URL. + * @deprecated Use `url` instead. + */ + src: Scalars['URL']['output']; + /** + * The location of the transformed image as a URL. + * + * All transformation arguments are considered "best-effort". If they can be applied to an image, they will be. + * Otherwise any transformations which an image type doesn't support will be ignored. + * + * @deprecated Use `url(transform:)` instead + */ + transformedSrc: Scalars['URL']['output']; + /** + * The location of the image as a URL. + * + * If no transform options are specified, then the original image will be preserved including any pre-applied transforms. + * + * All transformation options are considered "best-effort". Any transformation that the original image type doesn't support will be ignored. + * + * If you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases). + * + */ + url: Scalars['URL']['output']; + /** The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify. */ + width?: Maybe; +}; + + +/** Represents an image resource. */ +export type ImageTransformedSrcArgs = { + crop?: InputMaybe; + maxHeight?: InputMaybe; + maxWidth?: InputMaybe; + preferredContentType?: InputMaybe; + scale?: InputMaybe; +}; + + +/** Represents an image resource. */ +export type ImageUrlArgs = { + transform?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple Images. + * + */ +export type ImageConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ImageEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** List of supported image content types. */ +export type ImageContentType = + /** A JPG image. */ + | 'JPG' + /** A PNG image. */ + | 'PNG' + /** A WEBP image. */ + | 'WEBP'; + +/** + * An auto-generated type which holds one Image and a cursor during pagination. + * + */ +export type ImageEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of ImageEdge. */ + node: Image; +}; + +/** + * The available options for transforming an image. + * + * All transformation options are considered best effort. Any transformation that + * the original image type doesn't support will be ignored. + * + */ +export type ImageTransformInput = { + /** + * The region of the image to remain after cropping. + * Must be used in conjunction with the `maxWidth` and/or `maxHeight` fields, + * where the `maxWidth` and `maxHeight` aren't equal. + * The `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while + * a smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{ + * maxWidth: 5, maxHeight: 10, crop: LEFT }` will result + * in an image with a width of 5 and height of 10, where the right side of the image is removed. + * + */ + crop?: InputMaybe; + /** + * Image height in pixels between 1 and 5760. + * + */ + maxHeight?: InputMaybe; + /** + * Image width in pixels between 1 and 5760. + * + */ + maxWidth?: InputMaybe; + /** + * Convert the source image into the preferred content type. + * Supported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`. + * + */ + preferredContentType?: InputMaybe; + /** + * Image size multiplier for high-resolution retina displays. Must be within 1..3. + * + */ + scale?: InputMaybe; +}; + +/** A language. */ +export type Language = { + /** The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position. */ + endonymName: Scalars['String']['output']; + /** The ISO code. */ + isoCode: LanguageCode; + /** The name of the language in the current language. */ + name: Scalars['String']['output']; +}; + +/** ISO 639-1 language codes supported by Shopify. */ +export type LanguageCode = + /** Afrikaans. */ + | 'AF' + /** Akan. */ + | 'AK' + /** Amharic. */ + | 'AM' + /** Arabic. */ + | 'AR' + /** Assamese. */ + | 'AS' + /** Azerbaijani. */ + | 'AZ' + /** Belarusian. */ + | 'BE' + /** Bulgarian. */ + | 'BG' + /** Bambara. */ + | 'BM' + /** Bangla. */ + | 'BN' + /** Tibetan. */ + | 'BO' + /** Breton. */ + | 'BR' + /** Bosnian. */ + | 'BS' + /** Catalan. */ + | 'CA' + /** Chechen. */ + | 'CE' + /** Central Kurdish. */ + | 'CKB' + /** Czech. */ + | 'CS' + /** Church Slavic. */ + | 'CU' + /** Welsh. */ + | 'CY' + /** Danish. */ + | 'DA' + /** German. */ + | 'DE' + /** Dzongkha. */ + | 'DZ' + /** Ewe. */ + | 'EE' + /** Greek. */ + | 'EL' + /** English. */ + | 'EN' + /** Esperanto. */ + | 'EO' + /** Spanish. */ + | 'ES' + /** Estonian. */ + | 'ET' + /** Basque. */ + | 'EU' + /** Persian. */ + | 'FA' + /** Fulah. */ + | 'FF' + /** Finnish. */ + | 'FI' + /** Filipino. */ + | 'FIL' + /** Faroese. */ + | 'FO' + /** French. */ + | 'FR' + /** Western Frisian. */ + | 'FY' + /** Irish. */ + | 'GA' + /** Scottish Gaelic. */ + | 'GD' + /** Galician. */ + | 'GL' + /** Gujarati. */ + | 'GU' + /** Manx. */ + | 'GV' + /** Hausa. */ + | 'HA' + /** Hebrew. */ + | 'HE' + /** Hindi. */ + | 'HI' + /** Croatian. */ + | 'HR' + /** Hungarian. */ + | 'HU' + /** Armenian. */ + | 'HY' + /** Interlingua. */ + | 'IA' + /** Indonesian. */ + | 'ID' + /** Igbo. */ + | 'IG' + /** Sichuan Yi. */ + | 'II' + /** Icelandic. */ + | 'IS' + /** Italian. */ + | 'IT' + /** Japanese. */ + | 'JA' + /** Javanese. */ + | 'JV' + /** Georgian. */ + | 'KA' + /** Kikuyu. */ + | 'KI' + /** Kazakh. */ + | 'KK' + /** Kalaallisut. */ + | 'KL' + /** Khmer. */ + | 'KM' + /** Kannada. */ + | 'KN' + /** Korean. */ + | 'KO' + /** Kashmiri. */ + | 'KS' + /** Kurdish. */ + | 'KU' + /** Cornish. */ + | 'KW' + /** Kyrgyz. */ + | 'KY' + /** Latin. */ + | 'LA' + /** Luxembourgish. */ + | 'LB' + /** Ganda. */ + | 'LG' + /** Lingala. */ + | 'LN' + /** Lao. */ + | 'LO' + /** Lithuanian. */ + | 'LT' + /** Luba-Katanga. */ + | 'LU' + /** Latvian. */ + | 'LV' + /** Malagasy. */ + | 'MG' + /** Māori. */ + | 'MI' + /** Macedonian. */ + | 'MK' + /** Malayalam. */ + | 'ML' + /** Mongolian. */ + | 'MN' + /** Moldavian. */ + | 'MO' + /** Marathi. */ + | 'MR' + /** Malay. */ + | 'MS' + /** Maltese. */ + | 'MT' + /** Burmese. */ + | 'MY' + /** Norwegian (Bokmål). */ + | 'NB' + /** North Ndebele. */ + | 'ND' + /** Nepali. */ + | 'NE' + /** Dutch. */ + | 'NL' + /** Norwegian Nynorsk. */ + | 'NN' + /** Norwegian. */ + | 'NO' + /** Oromo. */ + | 'OM' + /** Odia. */ + | 'OR' + /** Ossetic. */ + | 'OS' + /** Punjabi. */ + | 'PA' + /** Polish. */ + | 'PL' + /** Pashto. */ + | 'PS' + /** Portuguese. */ + | 'PT' + /** Portuguese (Brazil). */ + | 'PT_BR' + /** Portuguese (Portugal). */ + | 'PT_PT' + /** Quechua. */ + | 'QU' + /** Romansh. */ + | 'RM' + /** Rundi. */ + | 'RN' + /** Romanian. */ + | 'RO' + /** Russian. */ + | 'RU' + /** Kinyarwanda. */ + | 'RW' + /** Sanskrit. */ + | 'SA' + /** Sardinian. */ + | 'SC' + /** Sindhi. */ + | 'SD' + /** Northern Sami. */ + | 'SE' + /** Sango. */ + | 'SG' + /** Serbo-Croatian. */ + | 'SH' + /** Sinhala. */ + | 'SI' + /** Slovak. */ + | 'SK' + /** Slovenian. */ + | 'SL' + /** Shona. */ + | 'SN' + /** Somali. */ + | 'SO' + /** Albanian. */ + | 'SQ' + /** Serbian. */ + | 'SR' + /** Sundanese. */ + | 'SU' + /** Swedish. */ + | 'SV' + /** Swahili. */ + | 'SW' + /** Tamil. */ + | 'TA' + /** Telugu. */ + | 'TE' + /** Tajik. */ + | 'TG' + /** Thai. */ + | 'TH' + /** Tigrinya. */ + | 'TI' + /** Turkmen. */ + | 'TK' + /** Tongan. */ + | 'TO' + /** Turkish. */ + | 'TR' + /** Tatar. */ + | 'TT' + /** Uyghur. */ + | 'UG' + /** Ukrainian. */ + | 'UK' + /** Urdu. */ + | 'UR' + /** Uzbek. */ + | 'UZ' + /** Vietnamese. */ + | 'VI' + /** Volapük. */ + | 'VO' + /** Wolof. */ + | 'WO' + /** Xhosa. */ + | 'XH' + /** Yiddish. */ + | 'YI' + /** Yoruba. */ + | 'YO' + /** Chinese. */ + | 'ZH' + /** Chinese (Simplified). */ + | 'ZH_CN' + /** Chinese (Traditional). */ + | 'ZH_TW' + /** Zulu. */ + | 'ZU'; + +/** Information about the localized experiences configured for the shop. */ +export type Localization = { + /** The list of countries with enabled localized experiences. */ + availableCountries: Array; + /** The list of languages available for the active country. */ + availableLanguages: Array; + /** The country of the active localized experience. Use the `@inContext` directive to change this value. */ + country: Country; + /** The language of the active localized experience. Use the `@inContext` directive to change this value. */ + language: Language; + /** The market including the country of the active localized experience. Use the `@inContext` directive to change this value. */ + market: Market; +}; + +/** Represents a location where product inventory is held. */ +export type Location = HasMetafields & Node & { + /** The address of the location. */ + address: LocationAddress; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The name of the location. */ + name: Scalars['String']['output']; +}; + + +/** Represents a location where product inventory is held. */ +export type LocationMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** Represents a location where product inventory is held. */ +export type LocationMetafieldsArgs = { + identifiers: Array; +}; + +/** + * Represents the address of a location. + * + */ +export type LocationAddress = { + /** The first line of the address for the location. */ + address1?: Maybe; + /** The second line of the address for the location. */ + address2?: Maybe; + /** The city of the location. */ + city?: Maybe; + /** The country of the location. */ + country?: Maybe; + /** The country code of the location. */ + countryCode?: Maybe; + /** A formatted version of the address for the location. */ + formatted: Array; + /** The latitude coordinates of the location. */ + latitude?: Maybe; + /** The longitude coordinates of the location. */ + longitude?: Maybe; + /** The phone number of the location. */ + phone?: Maybe; + /** The province of the location. */ + province?: Maybe; + /** + * The code for the province, state, or district of the address of the location. + * + */ + provinceCode?: Maybe; + /** The ZIP code of the location. */ + zip?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple Locations. + * + */ +export type LocationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in LocationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Location and a cursor during pagination. + * + */ +export type LocationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of LocationEdge. */ + node: Location; +}; + +/** The set of valid sort keys for the Location query. */ +export type LocationSortKeys = + /** Sort by the `city` value. */ + | 'CITY' + /** Sort by the `distance` value. */ + | 'DISTANCE' + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `name` value. */ + | 'NAME'; + +/** Represents a mailing address for customers and shipping. */ +export type MailingAddress = Node & { + /** The first line of the address. Typically the street address or PO Box number. */ + address1?: Maybe; + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + * + */ + address2?: Maybe; + /** The name of the city, district, village, or town. */ + city?: Maybe; + /** The name of the customer's company or organization. */ + company?: Maybe; + /** The name of the country. */ + country?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + * + * @deprecated Use `countryCodeV2` instead. + */ + countryCode?: Maybe; + /** + * The two-letter code for the country of the address. + * + * For example, US. + * + */ + countryCodeV2?: Maybe; + /** The first name of the customer. */ + firstName?: Maybe; + /** A formatted version of the address, customized by the provided arguments. */ + formatted: Array; + /** A comma-separated list of the values for city, province, and country. */ + formattedArea?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The last name of the customer. */ + lastName?: Maybe; + /** The latitude coordinate of the customer address. */ + latitude?: Maybe; + /** The longitude coordinate of the customer address. */ + longitude?: Maybe; + /** The full name of the customer, based on firstName and lastName. */ + name?: Maybe; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. + * + */ + phone?: Maybe; + /** The region of the address, such as the province, state, or district. */ + province?: Maybe; + /** + * The two-letter code for the region. + * + * For example, ON. + * + */ + provinceCode?: Maybe; + /** The zip or postal code of the address. */ + zip?: Maybe; +}; + + +/** Represents a mailing address for customers and shipping. */ +export type MailingAddressFormattedArgs = { + withCompany?: InputMaybe; + withName?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple MailingAddresses. + * + */ +export type MailingAddressConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MailingAddressEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MailingAddress and a cursor during pagination. + * + */ +export type MailingAddressEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of MailingAddressEdge. */ + node: MailingAddress; +}; + +/** The input fields to create or update a mailing address. */ +export type MailingAddressInput = { + /** + * The first line of the address. Typically the street address or PO Box number. + * + */ + address1?: InputMaybe; + /** + * The second line of the address. Typically the number of the apartment, suite, or unit. + * + */ + address2?: InputMaybe; + /** + * The name of the city, district, village, or town. + * + */ + city?: InputMaybe; + /** + * The name of the customer's company or organization. + * + */ + company?: InputMaybe; + /** The name of the country. */ + country?: InputMaybe; + /** The first name of the customer. */ + firstName?: InputMaybe; + /** The last name of the customer. */ + lastName?: InputMaybe; + /** + * A unique phone number for the customer. + * + * Formatted using E.164 standard. For example, _+16135551111_. + * + */ + phone?: InputMaybe; + /** The region of the address, such as the province, state, or district. */ + province?: InputMaybe; + /** The zip or postal code of the address. */ + zip?: InputMaybe; +}; + +/** + * Manual discount applications capture the intentions of a discount that was manually created. + * + */ +export type ManualDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** The description of the application. */ + description?: Maybe; + /** Which lines of targetType that the discount is allocated over. */ + targetSelection: DiscountApplicationTargetSelection; + /** The type of line that the discount is applicable towards. */ + targetType: DiscountApplicationTargetType; + /** The title of the application. */ + title: Scalars['String']['output']; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ +export type Market = HasMetafields & Node & { + /** + * A human-readable unique string for the market automatically generated from its title. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; +}; + + +/** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ +export type MarketMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets). */ +export type MarketMetafieldsArgs = { + identifiers: Array; +}; + +/** Represents a media interface. */ +export type Media = { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The presentation for a media. */ + presentation?: Maybe; + /** The preview image for the media. */ + previewImage?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple Media. + * + */ +export type MediaConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MediaEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** The possible content types for a media object. */ +export type MediaContentType = + /** An externally hosted video. */ + | 'EXTERNAL_VIDEO' + /** A Shopify hosted image. */ + | 'IMAGE' + /** A 3d model. */ + | 'MODEL_3D' + /** A Shopify hosted video. */ + | 'VIDEO'; + +/** + * An auto-generated type which holds one Media and a cursor during pagination. + * + */ +export type MediaEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of MediaEdge. */ + node: Media; +}; + +/** Host for a Media Resource. */ +export type MediaHost = + /** Host for Vimeo embedded videos. */ + | 'VIMEO' + /** Host for YouTube embedded videos. */ + | 'YOUTUBE'; + +/** Represents a Shopify hosted image. */ +export type MediaImage = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The image for the media. */ + image?: Maybe; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The presentation for a media. */ + presentation?: Maybe; + /** The preview image for the media. */ + previewImage?: Maybe; +}; + +/** A media presentation. */ +export type MediaPresentation = Node & { + /** A JSON object representing a presentation view. */ + asJson?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; +}; + + +/** A media presentation. */ +export type MediaPresentationAsJsonArgs = { + format: MediaPresentationFormat; +}; + +/** The possible formats for a media presentation. */ +export type MediaPresentationFormat = + /** A media image presentation. */ + | 'IMAGE' + /** A model viewer presentation. */ + | 'MODEL_VIEWER'; + +/** + * A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy + * of hyperlinks (items). + * + */ +export type Menu = Node & { + /** The menu's handle. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The menu's child items. */ + items: Array; + /** The count of items on the menu. */ + itemsCount: Scalars['Int']['output']; + /** The menu's title. */ + title: Scalars['String']['output']; +}; + +/** A menu item within a parent menu. */ +export type MenuItem = Node & { + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The menu item's child items. */ + items: Array; + /** The linked resource. */ + resource?: Maybe; + /** The ID of the linked resource. */ + resourceId?: Maybe; + /** The menu item's tags to filter a collection. */ + tags: Array; + /** The menu item's title. */ + title: Scalars['String']['output']; + /** The menu item's type. */ + type: MenuItemType; + /** The menu item's URL. */ + url?: Maybe; +}; + +/** + * The list of possible resources a `MenuItem` can reference. + * + */ +export type MenuItemResource = Article | Blog | Collection | Page | Product | ShopPolicy; + +/** A menu item type. */ +export type MenuItemType = + /** An article link. */ + | 'ARTICLE' + /** A blog link. */ + | 'BLOG' + /** A catalog link. */ + | 'CATALOG' + /** A collection link. */ + | 'COLLECTION' + /** A collection link. */ + | 'COLLECTIONS' + /** A frontpage link. */ + | 'FRONTPAGE' + /** An http link. */ + | 'HTTP' + /** A page link. */ + | 'PAGE' + /** A product link. */ + | 'PRODUCT' + /** A search link. */ + | 'SEARCH' + /** A shop policy link. */ + | 'SHOP_POLICY'; + +/** The merchandise to be purchased at checkout. */ +export type Merchandise = ProductVariant; + +/** + * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are + * comprised of keys, values, and value types. + * + */ +export type Metafield = Node & { + /** The date and time when the storefront metafield was created. */ + createdAt: Scalars['DateTime']['output']; + /** The description of a metafield. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The unique identifier for the metafield within its namespace. */ + key: Scalars['String']['output']; + /** The container for a group of metafields that the metafield is associated with. */ + namespace: Scalars['String']['output']; + /** The type of resource that the metafield is attached to. */ + parentResource: MetafieldParentResource; + /** Returns a reference object if the metafield's type is a resource reference. */ + reference?: Maybe; + /** A list of reference objects if the metafield's type is a resource reference list. */ + references?: Maybe; + /** + * The type name of the metafield. + * Refer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). + * + */ + type: Scalars['String']['output']; + /** The date and time when the metafield was last updated. */ + updatedAt: Scalars['DateTime']['output']; + /** The data stored in the metafield. Always stored as a string, regardless of the metafield's type. */ + value: Scalars['String']['output']; +}; + + +/** + * Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are + * comprised of keys, values, and value types. + * + */ +export type MetafieldReferencesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + +/** Possible error codes that can be returned by `MetafieldDeleteUserError`. */ +export type MetafieldDeleteErrorCode = + /** The owner ID is invalid. */ + | 'INVALID_OWNER' + /** Metafield not found. */ + | 'METAFIELD_DOES_NOT_EXIST'; + +/** An error that occurs during the execution of cart metafield deletion. */ +export type MetafieldDeleteUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** + * A filter used to view a subset of products in a collection matching a specific metafield value. + * + * Only the following metafield types are currently supported: + * - `number_integer` + * - `number_decimal` + * - `single_line_text_field` + * - `boolean` as of 2022-04. + * + */ +export type MetafieldFilter = { + /** The key of the metafield to filter on. */ + key: Scalars['String']['input']; + /** The namespace of the metafield to filter on. */ + namespace: Scalars['String']['input']; + /** The value of the metafield. */ + value: Scalars['String']['input']; +}; + +/** A resource that the metafield belongs to. */ +export type MetafieldParentResource = Article | Blog | Cart | Collection | Customer | Location | Market | Order | Page | Product | ProductVariant | Shop; + +/** + * Returns the resource which is being referred to by a metafield. + * + */ +export type MetafieldReference = Collection | GenericFile | MediaImage | Metaobject | Page | Product | ProductVariant | Video; + +/** + * An auto-generated type for paginating through multiple MetafieldReferences. + * + */ +export type MetafieldReferenceConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetafieldReferenceEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one MetafieldReference and a cursor during pagination. + * + */ +export type MetafieldReferenceEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of MetafieldReferenceEdge. */ + node: MetafieldReference; +}; + +/** An error that occurs during the execution of `MetafieldsSet`. */ +export type MetafieldsSetUserError = DisplayableError & { + /** The error code. */ + code?: Maybe; + /** The index of the array element that's causing the error. */ + elementIndex?: Maybe; + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** Possible error codes that can be returned by `MetafieldsSetUserError`. */ +export type MetafieldsSetUserErrorCode = + /** The input value is blank. */ + | 'BLANK' + /** The input value isn't included in the list. */ + | 'INCLUSION' + /** The owner ID is invalid. */ + | 'INVALID_OWNER' + /** The type is invalid. */ + | 'INVALID_TYPE' + /** The value is invalid for metafield type or for definition options. */ + | 'INVALID_VALUE' + /** The input value should be less than or equal to the maximum value allowed. */ + | 'LESS_THAN_OR_EQUAL_TO' + /** The input value needs to be blank. */ + | 'PRESENT' + /** The input value is too long. */ + | 'TOO_LONG' + /** The input value is too short. */ + | 'TOO_SHORT'; + +/** An instance of a user-defined model based on a MetaobjectDefinition. */ +export type Metaobject = Node & { + /** Accesses a field of the object by key. */ + field?: Maybe; + /** + * All object fields with defined values. + * Omitted object keys can be assumed null, and no guarantees are made about field order. + * + */ + fields: Array; + /** The unique handle of the metaobject. Useful as a custom ID. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The type of the metaobject. Defines the namespace of its associated metafields. */ + type: Scalars['String']['output']; + /** The date and time when the metaobject was last updated. */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** An instance of a user-defined model based on a MetaobjectDefinition. */ +export type MetaobjectFieldArgs = { + key: Scalars['String']['input']; +}; + +/** + * An auto-generated type for paginating through multiple Metaobjects. + * + */ +export type MetaobjectConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in MetaobjectEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Metaobject and a cursor during pagination. + * + */ +export type MetaobjectEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of MetaobjectEdge. */ + node: Metaobject; +}; + +/** Provides the value of a Metaobject field. */ +export type MetaobjectField = { + /** The field key. */ + key: Scalars['String']['output']; + /** A referenced object if the field type is a resource reference. */ + reference?: Maybe; + /** A list of referenced objects if the field type is a resource reference list. */ + references?: Maybe; + /** + * The type name of the field. + * See the list of [supported types](https://shopify.dev/apps/metafields/definitions/types). + * + */ + type: Scalars['String']['output']; + /** The field value. */ + value?: Maybe; +}; + + +/** Provides the value of a Metaobject field. */ +export type MetaobjectFieldReferencesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + +/** The input fields used to retrieve a metaobject by handle. */ +export type MetaobjectHandleInput = { + /** The handle of the metaobject. */ + handle: Scalars['String']['input']; + /** The type of the metaobject. */ + type: Scalars['String']['input']; +}; + +/** Represents a Shopify hosted 3D model. */ +export type Model3d = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The presentation for a media. */ + presentation?: Maybe; + /** The preview image for the media. */ + previewImage?: Maybe; + /** The sources for a 3d model. */ + sources: Array; +}; + +/** Represents a source for a Shopify hosted 3d model. */ +export type Model3dSource = { + /** The filesize of the 3d model. */ + filesize: Scalars['Int']['output']; + /** The format of the 3d model. */ + format: Scalars['String']['output']; + /** The MIME type of the 3d model. */ + mimeType: Scalars['String']['output']; + /** The URL of the 3d model. */ + url: Scalars['String']['output']; +}; + +/** The input fields for a monetary value with currency. */ +export type MoneyInput = { + /** Decimal money amount. */ + amount: Scalars['Decimal']['input']; + /** Currency of the money. */ + currencyCode: CurrencyCode; +}; + +/** + * A monetary value with currency. + * + */ +export type MoneyV2 = { + /** Decimal money amount. */ + amount: Scalars['Decimal']['output']; + /** Currency of the money. */ + currencyCode: CurrencyCode; +}; + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type Mutation = { + /** Updates the attributes on a cart. */ + cartAttributesUpdate?: Maybe; + /** + * Updates customer information associated with a cart. + * Buyer identity is used to determine + * [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) + * and should match the customer's shipping address. + * + */ + cartBuyerIdentityUpdate?: Maybe; + /** Creates a new cart. */ + cartCreate?: Maybe; + /** Updates the discount codes applied to the cart. */ + cartDiscountCodesUpdate?: Maybe; + /** Adds a merchandise line to the cart. */ + cartLinesAdd?: Maybe; + /** Removes one or more merchandise lines from the cart. */ + cartLinesRemove?: Maybe; + /** Updates one or more merchandise lines on a cart. */ + cartLinesUpdate?: Maybe; + /** Deletes a cart metafield. */ + cartMetafieldDelete?: Maybe; + /** + * Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. + * + * Allows a maximum of 25 cart metafields to be set at a time. + * + */ + cartMetafieldsSet?: Maybe; + /** Updates the note on the cart. */ + cartNoteUpdate?: Maybe; + /** Update the customer's payment method that will be used to checkout. */ + cartPaymentUpdate?: Maybe; + /** Update the selected delivery options for a delivery group. */ + cartSelectedDeliveryOptionsUpdate?: Maybe; + /** Submit the cart for checkout completion. */ + cartSubmitForCompletion?: Maybe; + /** Updates the attributes of a checkout if `allowPartialAddresses` is `true`. */ + checkoutAttributesUpdateV2?: Maybe; + /** Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. */ + checkoutCompleteFree?: Maybe; + /** Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing). */ + checkoutCompleteWithCreditCardV2?: Maybe; + /** Completes a checkout with a tokenized payment. */ + checkoutCompleteWithTokenizedPaymentV3?: Maybe; + /** Creates a new checkout. */ + checkoutCreate?: Maybe; + /** Associates a customer to the checkout. */ + checkoutCustomerAssociateV2?: Maybe; + /** Disassociates the current checkout customer from the checkout. */ + checkoutCustomerDisassociateV2?: Maybe; + /** Applies a discount to an existing checkout using a discount code. */ + checkoutDiscountCodeApplyV2?: Maybe; + /** Removes the applied discounts from an existing checkout. */ + checkoutDiscountCodeRemove?: Maybe; + /** Updates the email on an existing checkout. */ + checkoutEmailUpdateV2?: Maybe; + /** Removes an applied gift card from the checkout. */ + checkoutGiftCardRemoveV2?: Maybe; + /** Appends gift cards to an existing checkout. */ + checkoutGiftCardsAppend?: Maybe; + /** Adds a list of line items to a checkout. */ + checkoutLineItemsAdd?: Maybe; + /** Removes line items from an existing checkout. */ + checkoutLineItemsRemove?: Maybe; + /** Sets a list of line items to a checkout. */ + checkoutLineItemsReplace?: Maybe; + /** Updates line items on a checkout. */ + checkoutLineItemsUpdate?: Maybe; + /** Updates the shipping address of an existing checkout. */ + checkoutShippingAddressUpdateV2?: Maybe; + /** Updates the shipping lines on an existing checkout. */ + checkoutShippingLineUpdate?: Maybe; + /** + * Creates a customer access token. + * The customer access token is required to modify the customer object in any way. + * + */ + customerAccessTokenCreate?: Maybe; + /** + * Creates a customer access token using a + * [multipass token](https://shopify.dev/api/multipass) instead of email and + * password. A customer record is created if the customer doesn't exist. If a customer + * record already exists but the record is disabled, then the customer record is enabled. + * + */ + customerAccessTokenCreateWithMultipass?: Maybe; + /** Permanently destroys a customer access token. */ + customerAccessTokenDelete?: Maybe; + /** + * Renews a customer access token. + * + * Access token renewal must happen *before* a token expires. + * If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`. + * + */ + customerAccessTokenRenew?: Maybe; + /** Activates a customer. */ + customerActivate?: Maybe; + /** Activates a customer with the activation url received from `customerCreate`. */ + customerActivateByUrl?: Maybe; + /** Creates a new address for a customer. */ + customerAddressCreate?: Maybe; + /** Permanently deletes the address of an existing customer. */ + customerAddressDelete?: Maybe; + /** Updates the address of an existing customer. */ + customerAddressUpdate?: Maybe; + /** Creates a new customer. */ + customerCreate?: Maybe; + /** Updates the default address of an existing customer. */ + customerDefaultAddressUpdate?: Maybe; + /** + * Sends a reset password email to the customer. The reset password + * email contains a reset password URL and token that you can pass to + * the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or + * [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the + * customer password. + * + * This mutation is throttled by IP. With private access, + * you can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP. + * The header is case-sensitive and must be sent as `Shopify-Storefront-Buyer-IP`. + * + * Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this + * mutation presents a security risk. + * + */ + customerRecover?: Maybe; + /** + * "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * + */ + customerReset?: Maybe; + /** + * "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation." + * + */ + customerResetByUrl?: Maybe; + /** Updates an existing customer. */ + customerUpdate?: Maybe; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartAttributesUpdateArgs = { + attributes: Array; + cartId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartBuyerIdentityUpdateArgs = { + buyerIdentity: CartBuyerIdentityInput; + cartId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartCreateArgs = { + input?: InputMaybe; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartDiscountCodesUpdateArgs = { + cartId: Scalars['ID']['input']; + discountCodes?: InputMaybe>; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesAddArgs = { + cartId: Scalars['ID']['input']; + lines: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesRemoveArgs = { + cartId: Scalars['ID']['input']; + lineIds: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartLinesUpdateArgs = { + cartId: Scalars['ID']['input']; + lines: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartMetafieldDeleteArgs = { + input: CartMetafieldDeleteInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartMetafieldsSetArgs = { + metafields: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartNoteUpdateArgs = { + cartId: Scalars['ID']['input']; + note?: InputMaybe; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartPaymentUpdateArgs = { + cartId: Scalars['ID']['input']; + payment: CartPaymentInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartSelectedDeliveryOptionsUpdateArgs = { + cartId: Scalars['ID']['input']; + selectedDeliveryOptions: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCartSubmitForCompletionArgs = { + attemptToken: Scalars['String']['input']; + cartId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutAttributesUpdateV2Args = { + checkoutId: Scalars['ID']['input']; + input: CheckoutAttributesUpdateV2Input; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCompleteFreeArgs = { + checkoutId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCompleteWithCreditCardV2Args = { + checkoutId: Scalars['ID']['input']; + payment: CreditCardPaymentInputV2; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCompleteWithTokenizedPaymentV3Args = { + checkoutId: Scalars['ID']['input']; + payment: TokenizedPaymentInputV3; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCreateArgs = { + input: CheckoutCreateInput; + queueToken?: InputMaybe; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCustomerAssociateV2Args = { + checkoutId: Scalars['ID']['input']; + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutCustomerDisassociateV2Args = { + checkoutId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutDiscountCodeApplyV2Args = { + checkoutId: Scalars['ID']['input']; + discountCode: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutDiscountCodeRemoveArgs = { + checkoutId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutEmailUpdateV2Args = { + checkoutId: Scalars['ID']['input']; + email: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutGiftCardRemoveV2Args = { + appliedGiftCardId: Scalars['ID']['input']; + checkoutId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutGiftCardsAppendArgs = { + checkoutId: Scalars['ID']['input']; + giftCardCodes: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutLineItemsAddArgs = { + checkoutId: Scalars['ID']['input']; + lineItems: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutLineItemsRemoveArgs = { + checkoutId: Scalars['ID']['input']; + lineItemIds: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutLineItemsReplaceArgs = { + checkoutId: Scalars['ID']['input']; + lineItems: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutLineItemsUpdateArgs = { + checkoutId: Scalars['ID']['input']; + lineItems: Array; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutShippingAddressUpdateV2Args = { + checkoutId: Scalars['ID']['input']; + shippingAddress: MailingAddressInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCheckoutShippingLineUpdateArgs = { + checkoutId: Scalars['ID']['input']; + shippingRateHandle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAccessTokenCreateArgs = { + input: CustomerAccessTokenCreateInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAccessTokenCreateWithMultipassArgs = { + multipassToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAccessTokenDeleteArgs = { + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAccessTokenRenewArgs = { + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerActivateArgs = { + id: Scalars['ID']['input']; + input: CustomerActivateInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerActivateByUrlArgs = { + activationUrl: Scalars['URL']['input']; + password: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAddressCreateArgs = { + address: MailingAddressInput; + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAddressDeleteArgs = { + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerAddressUpdateArgs = { + address: MailingAddressInput; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerCreateArgs = { + input: CustomerCreateInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerDefaultAddressUpdateArgs = { + addressId: Scalars['ID']['input']; + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerRecoverArgs = { + email: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerResetArgs = { + id: Scalars['ID']['input']; + input: CustomerResetInput; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerResetByUrlArgs = { + password: Scalars['String']['input']; + resetUrl: Scalars['URL']['input']; +}; + + +/** The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start. */ +export type MutationCustomerUpdateArgs = { + customer: CustomerUpdateInput; + customerAccessToken: Scalars['String']['input']; +}; + +/** + * An object with an ID field to support global identification, in accordance with the + * [Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface). + * This interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node) + * and [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries. + * + */ +export type Node = { + /** A globally-unique ID. */ + id: Scalars['ID']['output']; +}; + +/** Represents a resource that can be published to the Online Store sales channel. */ +export type OnlineStorePublishable = { + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; +}; + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type Order = HasMetafields & Node & { + /** The address associated with the payment method. */ + billingAddress?: Maybe; + /** The reason for the order's cancellation. Returns `null` if the order wasn't canceled. */ + cancelReason?: Maybe; + /** The date and time when the order was canceled. Returns null if the order wasn't canceled. */ + canceledAt?: Maybe; + /** The code of the currency used for the payment. */ + currencyCode: CurrencyCode; + /** The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order. */ + currentSubtotalPrice: MoneyV2; + /** The total cost of duties for the order, including refunds. */ + currentTotalDuties?: Maybe; + /** The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed. */ + currentTotalPrice: MoneyV2; + /** The total of all taxes applied to the order, excluding taxes for returned line items. */ + currentTotalTax: MoneyV2; + /** A list of the custom attributes added to the order. */ + customAttributes: Array; + /** The locale code in which this specific order happened. */ + customerLocale?: Maybe; + /** The unique URL that the customer can use to access the order. */ + customerUrl?: Maybe; + /** Discounts that have been applied on the order. */ + discountApplications: DiscountApplicationConnection; + /** Whether the order has had any edits applied or not. */ + edited: Scalars['Boolean']['output']; + /** The customer's email address. */ + email?: Maybe; + /** The financial status of the order. */ + financialStatus?: Maybe; + /** The fulfillment status for the order. */ + fulfillmentStatus: OrderFulfillmentStatus; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** List of the order’s line items. */ + lineItems: OrderLineItemConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** + * Unique identifier for the order that appears on the order. + * For example, _#1000_ or _Store1001. + * + */ + name: Scalars['String']['output']; + /** A unique numeric identifier for the order for use by shop owner and customer. */ + orderNumber: Scalars['Int']['output']; + /** The total cost of duties charged at checkout. */ + originalTotalDuties?: Maybe; + /** The total price of the order before any applied edits. */ + originalTotalPrice: MoneyV2; + /** The customer's phone number for receiving SMS notifications. */ + phone?: Maybe; + /** + * The date and time when the order was imported. + * This value can be set to dates in the past when importing from other systems. + * If no value is provided, it will be auto-generated based on current date and time. + * + */ + processedAt: Scalars['DateTime']['output']; + /** The address to where the order will be shipped. */ + shippingAddress?: Maybe; + /** + * The discounts that have been allocated onto the shipping line by discount applications. + * + */ + shippingDiscountAllocations: Array; + /** The unique URL for the order's status page. */ + statusUrl: Scalars['URL']['output']; + /** Price of the order before shipping and taxes. */ + subtotalPrice?: Maybe; + /** + * Price of the order before duties, shipping and taxes. + * @deprecated Use `subtotalPrice` instead. + */ + subtotalPriceV2?: Maybe; + /** List of the order’s successful fulfillments. */ + successfulFulfillments?: Maybe>; + /** The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). */ + totalPrice: MoneyV2; + /** + * The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive). + * @deprecated Use `totalPrice` instead. + */ + totalPriceV2: MoneyV2; + /** The total amount that has been refunded. */ + totalRefunded: MoneyV2; + /** + * The total amount that has been refunded. + * @deprecated Use `totalRefunded` instead. + */ + totalRefundedV2: MoneyV2; + /** The total cost of shipping. */ + totalShippingPrice: MoneyV2; + /** + * The total cost of shipping. + * @deprecated Use `totalShippingPrice` instead. + */ + totalShippingPriceV2: MoneyV2; + /** The total cost of taxes. */ + totalTax?: Maybe; + /** + * The total cost of taxes. + * @deprecated Use `totalTax` instead. + */ + totalTaxV2?: Maybe; +}; + + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderDiscountApplicationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderLineItemsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderMetafieldsArgs = { + identifiers: Array; +}; + + +/** An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information. */ +export type OrderSuccessfulFulfillmentsArgs = { + first?: InputMaybe; +}; + +/** Represents the reason for the order's cancellation. */ +export type OrderCancelReason = + /** The customer wanted to cancel the order. */ + | 'CUSTOMER' + /** Payment was declined. */ + | 'DECLINED' + /** The order was fraudulent. */ + | 'FRAUD' + /** There was insufficient inventory. */ + | 'INVENTORY' + /** The order was canceled for an unlisted reason. */ + | 'OTHER'; + +/** + * An auto-generated type for paginating through multiple Orders. + * + */ +export type OrderConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in OrderEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** The total count of Orders. */ + totalCount: Scalars['UnsignedInt64']['output']; +}; + +/** + * An auto-generated type which holds one Order and a cursor during pagination. + * + */ +export type OrderEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of OrderEdge. */ + node: Order; +}; + +/** Represents the order's current financial status. */ +export type OrderFinancialStatus = + /** Displayed as **Authorized**. */ + | 'AUTHORIZED' + /** Displayed as **Paid**. */ + | 'PAID' + /** Displayed as **Partially paid**. */ + | 'PARTIALLY_PAID' + /** Displayed as **Partially refunded**. */ + | 'PARTIALLY_REFUNDED' + /** Displayed as **Pending**. */ + | 'PENDING' + /** Displayed as **Refunded**. */ + | 'REFUNDED' + /** Displayed as **Voided**. */ + | 'VOIDED'; + +/** Represents the order's aggregated fulfillment status for display purposes. */ +export type OrderFulfillmentStatus = + /** Displayed as **Fulfilled**. All of the items in the order have been fulfilled. */ + | 'FULFILLED' + /** Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service. */ + | 'IN_PROGRESS' + /** Displayed as **On hold**. All of the unfulfilled items in this order are on hold. */ + | 'ON_HOLD' + /** Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by "UNFULFILLED" status. */ + | 'OPEN' + /** Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled. */ + | 'PARTIALLY_FULFILLED' + /** Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by "IN_PROGRESS" status. */ + | 'PENDING_FULFILLMENT' + /** Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by "UNFULFILLED" status. */ + | 'RESTOCKED' + /** Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time. */ + | 'SCHEDULED' + /** Displayed as **Unfulfilled**. None of the items in the order have been fulfilled. */ + | 'UNFULFILLED'; + +/** Represents a single line in an order. There is one line item for each distinct product variant. */ +export type OrderLineItem = { + /** The number of entries associated to the line item minus the items that have been removed. */ + currentQuantity: Scalars['Int']['output']; + /** List of custom attributes associated to the line item. */ + customAttributes: Array; + /** The discounts that have been allocated onto the order line item by discount applications. */ + discountAllocations: Array; + /** The total price of the line item, including discounts, and displayed in the presentment currency. */ + discountedTotalPrice: MoneyV2; + /** The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it's displayed in the presentment currency. */ + originalTotalPrice: MoneyV2; + /** The number of products variants associated to the line item. */ + quantity: Scalars['Int']['output']; + /** The title of the product combined with title of the variant. */ + title: Scalars['String']['output']; + /** The product variant object associated to the line item. */ + variant?: Maybe; +}; + +/** + * An auto-generated type for paginating through multiple OrderLineItems. + * + */ +export type OrderLineItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in OrderLineItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one OrderLineItem and a cursor during pagination. + * + */ +export type OrderLineItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of OrderLineItemEdge. */ + node: OrderLineItem; +}; + +/** The set of valid sort keys for the Order query. */ +export type OrderSortKeys = + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `processed_at` value. */ + | 'PROCESSED_AT' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `total_price` value. */ + | 'TOTAL_PRICE'; + +/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ +export type Page = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** The description of the page, complete with HTML formatting. */ + body: Scalars['HTML']['output']; + /** Summary of the page body. */ + bodySummary: Scalars['String']['output']; + /** The timestamp of the page creation. */ + createdAt: Scalars['DateTime']['output']; + /** A human-friendly unique string for the page automatically generated from its title. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** The page's SEO information. */ + seo?: Maybe; + /** The title of the page. */ + title: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** The timestamp of the latest page update. */ + updatedAt: Scalars['DateTime']['output']; +}; + + +/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ +export type PageMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store. */ +export type PageMetafieldsArgs = { + identifiers: Array; +}; + +/** + * An auto-generated type for paginating through multiple Pages. + * + */ +export type PageConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in PageEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Page and a cursor during pagination. + * + */ +export type PageEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of PageEdge. */ + node: Page; +}; + +/** + * Returns information about pagination in a connection, in accordance with the + * [Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo). + * For more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql). + * + */ +export type PageInfo = { + /** The cursor corresponding to the last node in edges. */ + endCursor?: Maybe; + /** Whether there are more pages to fetch following the current page. */ + hasNextPage: Scalars['Boolean']['output']; + /** Whether there are any pages prior to the current page. */ + hasPreviousPage: Scalars['Boolean']['output']; + /** The cursor corresponding to the first node in edges. */ + startCursor?: Maybe; +}; + +/** The set of valid sort keys for the Page query. */ +export type PageSortKeys = + /** Sort by the `id` value. */ + | 'ID' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE' + /** Sort by the `updated_at` value. */ + | 'UPDATED_AT'; + +/** A payment applied to a checkout. */ +export type Payment = Node & { + /** The amount of the payment. */ + amount: MoneyV2; + /** + * The amount of the payment. + * @deprecated Use `amount` instead. + */ + amountV2: MoneyV2; + /** The billing address for the payment. */ + billingAddress?: Maybe; + /** The checkout to which the payment belongs. */ + checkout: Checkout; + /** The credit card used for the payment in the case of direct payments. */ + creditCard?: Maybe; + /** A message describing a processing error during asynchronous processing. */ + errorMessage?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** + * A client-side generated token to identify a payment and perform idempotent operations. + * For more information, refer to + * [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). + * + */ + idempotencyKey?: Maybe; + /** The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow. */ + nextActionUrl?: Maybe; + /** Whether the payment is still processing asynchronously. */ + ready: Scalars['Boolean']['output']; + /** A flag to indicate if the payment is to be done in test mode for gateways that support it. */ + test: Scalars['Boolean']['output']; + /** The actual transaction recorded by Shopify after having processed the payment with the gateway. */ + transaction?: Maybe; +}; + +/** Settings related to payments. */ +export type PaymentSettings = { + /** List of the card brands which the shop accepts. */ + acceptedCardBrands: Array; + /** The url pointing to the endpoint to vault credit cards. */ + cardVaultUrl: Scalars['URL']['output']; + /** The country where the shop is located. */ + countryCode: CountryCode; + /** The three-letter code for the shop's primary currency. */ + currencyCode: CurrencyCode; + /** + * A list of enabled currencies (ISO 4217 format) that the shop accepts. + * Merchants can enable currencies from their Shopify Payments settings in the Shopify admin. + * + */ + enabledPresentmentCurrencies: Array; + /** The shop’s Shopify Payments account ID. */ + shopifyPaymentsAccountId?: Maybe; + /** List of the digital wallets which the shop supports. */ + supportedDigitalWallets: Array; +}; + +/** The valid values for the types of payment token. */ +export type PaymentTokenType = + /** Apple Pay token type. */ + | 'APPLE_PAY' + /** Google Pay token type. */ + | 'GOOGLE_PAY' + /** Shopify Pay token type. */ + | 'SHOPIFY_PAY' + /** Stripe token type. */ + | 'STRIPE_VAULT_TOKEN' + /** Vault payment token type. */ + | 'VAULT'; + +/** Decides the distribution of results. */ +export type PredictiveSearchLimitScope = + /** Return results up to limit across all types. */ + | 'ALL' + /** Return results up to limit per type. */ + | 'EACH'; + +/** + * A predictive search result represents a list of products, collections, pages, articles, and query suggestions + * that matches the predictive search query. + * + */ +export type PredictiveSearchResult = { + /** The articles that match the search query. */ + articles: Array
; + /** The articles that match the search query. */ + collections: Array; + /** The pages that match the search query. */ + pages: Array; + /** The products that match the search query. */ + products: Array; + /** The query suggestions that are relevant to the search query. */ + queries: Array; +}; + +/** The types of search items to perform predictive search on. */ +export type PredictiveSearchType = + /** Returns matching articles. */ + | 'ARTICLE' + /** Returns matching collections. */ + | 'COLLECTION' + /** Returns matching pages. */ + | 'PAGE' + /** Returns matching products. */ + | 'PRODUCT' + /** Returns matching query strings. */ + | 'QUERY'; + +/** + * The input fields for a filter used to view a subset of products in a collection matching a specific price range. + * + */ +export type PriceRangeFilter = { + /** The maximum price in the range. Empty indicates no max price. */ + max?: InputMaybe; + /** The minimum price in the range. Defaults to zero. */ + min?: InputMaybe; +}; + +/** The value of the percentage pricing object. */ +export type PricingPercentageValue = { + /** The percentage value of the object. */ + percentage: Scalars['Float']['output']; +}; + +/** The price value (fixed or percentage) for a discount application. */ +export type PricingValue = MoneyV2 | PricingPercentageValue; + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type Product = HasMetafields & Node & OnlineStorePublishable & Trackable & { + /** Indicates if at least one product variant is available for sale. */ + availableForSale: Scalars['Boolean']['output']; + /** List of collections a product belongs to. */ + collections: CollectionConnection; + /** The compare at price of the product across all variants. */ + compareAtPriceRange: ProductPriceRange; + /** The date and time when the product was created. */ + createdAt: Scalars['DateTime']['output']; + /** Stripped description of the product, single line with HTML tags removed. */ + description: Scalars['String']['output']; + /** The description of the product, complete with HTML formatting. */ + descriptionHtml: Scalars['HTML']['output']; + /** + * The featured image for the product. + * + * This field is functionally equivalent to `images(first: 1)`. + * + */ + featuredImage?: Maybe; + /** + * A human-friendly unique string for the Product automatically generated from its title. + * They are used by the Liquid templating language to refer to objects. + * + */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** List of images associated with the product. */ + images: ImageConnection; + /** Whether the product is a gift card. */ + isGiftCard: Scalars['Boolean']['output']; + /** The media associated with the product. */ + media: MediaConnection; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel. */ + onlineStoreUrl?: Maybe; + /** List of product options. */ + options: Array; + /** The price range. */ + priceRange: ProductPriceRange; + /** A categorization that a product can be tagged with, commonly used for filtering and searching. */ + productType: Scalars['String']['output']; + /** The date and time when the product was published to the channel. */ + publishedAt: Scalars['DateTime']['output']; + /** Whether the product can only be purchased with a selling plan. */ + requiresSellingPlan: Scalars['Boolean']['output']; + /** A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ + sellingPlanGroups: SellingPlanGroupConnection; + /** The product's SEO information. */ + seo: Seo; + /** + * A comma separated list of tags that have been added to the product. + * Additional access scope required for private apps: unauthenticated_read_product_tags. + * + */ + tags: Array; + /** The product’s title. */ + title: Scalars['String']['output']; + /** The total quantity of inventory in stock for this Product. */ + totalInventory?: Maybe; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; + /** + * The date and time when the product was last modified. + * A product's `updatedAt` value can change for different reasons. For example, if an order + * is placed for a product that has inventory tracking set up, then the inventory adjustment + * is counted as an update. + * + */ + updatedAt: Scalars['DateTime']['output']; + /** + * Find a product’s variant based on its selected options. + * This is useful for converting a user’s selection of product options into a single matching variant. + * If there is not a variant for the selected options, `null` will be returned. + * + */ + variantBySelectedOptions?: Maybe; + /** List of the product’s variants. */ + variants: ProductVariantConnection; + /** The product’s vendor name. */ + vendor: Scalars['String']['output']; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductDescriptionArgs = { + truncateAt?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductImagesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductMediaArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductMetafieldsArgs = { + identifiers: Array; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductOptionsArgs = { + first?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductSellingPlanGroupsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductVariantBySelectedOptionsArgs = { + selectedOptions: Array; +}; + + +/** + * A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be. + * For example, a digital download (such as a movie, music or ebook file) also + * qualifies as a product, as do services (such as equipment rental, work for hire, + * customization of another product or an extended warranty). + * + */ +export type ProductVariantsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** The set of valid sort keys for the ProductCollection query. */ +export type ProductCollectionSortKeys = + /** Sort by the `best-selling` value. */ + | 'BEST_SELLING' + /** Sort by the `collection-default` value. */ + | 'COLLECTION_DEFAULT' + /** Sort by the `created` value. */ + | 'CREATED' + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `manual` value. */ + | 'MANUAL' + /** Sort by the `price` value. */ + | 'PRICE' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE'; + +/** + * An auto-generated type for paginating through multiple Products. + * + */ +export type ProductConnection = { + /** A list of edges. */ + edges: Array; + /** A list of available filters. */ + filters: Array; + /** A list of the nodes contained in ProductEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one Product and a cursor during pagination. + * + */ +export type ProductEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of ProductEdge. */ + node: Product; +}; + +/** + * The input fields for a filter used to view a subset of products in a collection. + * By default, the `available` and `price` filters are enabled. Filters are customized with the Shopify Search & Discovery app. + * Learn more about [customizing storefront filtering](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters). + * + */ +export type ProductFilter = { + /** Filter on if the product is available for sale. */ + available?: InputMaybe; + /** A range of prices to filter with-in. */ + price?: InputMaybe; + /** A product metafield to filter on. */ + productMetafield?: InputMaybe; + /** The product type to filter on. */ + productType?: InputMaybe; + /** The product vendor to filter on. */ + productVendor?: InputMaybe; + /** A product tag to filter on. */ + tag?: InputMaybe; + /** A variant metafield to filter on. */ + variantMetafield?: InputMaybe; + /** A variant option to filter on. */ + variantOption?: InputMaybe; +}; + +/** The set of valid sort keys for the ProductImage query. */ +export type ProductImageSortKeys = + /** Sort by the `created_at` value. */ + | 'CREATED_AT' + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `position` value. */ + | 'POSITION' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE'; + +/** The set of valid sort keys for the ProductMedia query. */ +export type ProductMediaSortKeys = + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `position` value. */ + | 'POSITION' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE'; + +/** + * Product property names like "Size", "Color", and "Material" that the customers can select. + * Variants are selected based on permutations of these options. + * 255 characters limit each. + * + */ +export type ProductOption = Node & { + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The product option’s name. */ + name: Scalars['String']['output']; + /** The corresponding value to the product option name. */ + values: Array; +}; + +/** The price range of the product. */ +export type ProductPriceRange = { + /** The highest variant's price. */ + maxVariantPrice: MoneyV2; + /** The lowest variant's price. */ + minVariantPrice: MoneyV2; +}; + +/** + * The recommendation intent that is used to generate product recommendations. + * You can use intent to generate product recommendations according to different strategies. + * + */ +export type ProductRecommendationIntent = + /** Offer customers products that are complementary to a product for which recommendations are to be fetched. An example is add-on products that display in a Pair it with section. */ + | 'COMPLEMENTARY' + /** Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section. */ + | 'RELATED'; + +/** The set of valid sort keys for the Product query. */ +export type ProductSortKeys = + /** Sort by the `best_selling` value. */ + | 'BEST_SELLING' + /** Sort by the `created_at` value. */ + | 'CREATED_AT' + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `price` value. */ + | 'PRICE' + /** Sort by the `product_type` value. */ + | 'PRODUCT_TYPE' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `title` value. */ + | 'TITLE' + /** Sort by the `updated_at` value. */ + | 'UPDATED_AT' + /** Sort by the `vendor` value. */ + | 'VENDOR'; + +/** + * A product variant represents a different version of a product, such as differing sizes or differing colors. + * + */ +export type ProductVariant = HasMetafields & Node & { + /** Indicates if the product variant is available for sale. */ + availableForSale: Scalars['Boolean']['output']; + /** The barcode (for example, ISBN, UPC, or GTIN) associated with the variant. */ + barcode?: Maybe; + /** The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`. */ + compareAtPrice?: Maybe; + /** + * The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`. + * @deprecated Use `compareAtPrice` instead. + */ + compareAtPriceV2?: Maybe; + /** Whether a product is out of stock but still available for purchase (used for backorders). */ + currentlyNotInStock: Scalars['Boolean']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Image associated with the product variant. This field falls back to the product image if no image is available. */ + image?: Maybe; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** The product variant’s price. */ + price: MoneyV2; + /** + * The product variant’s price. + * @deprecated Use `price` instead. + */ + priceV2: MoneyV2; + /** The product object that the product variant belongs to. */ + product: Product; + /** The total sellable quantity of the variant for online sales channels. */ + quantityAvailable?: Maybe; + /** Whether a customer needs to provide a shipping address when placing an order for the product variant. */ + requiresShipping: Scalars['Boolean']['output']; + /** List of product options applied to the variant. */ + selectedOptions: Array; + /** Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing. */ + sellingPlanAllocations: SellingPlanAllocationConnection; + /** The SKU (stock keeping unit) associated with the variant. */ + sku?: Maybe; + /** The in-store pickup availability of this variant by location. */ + storeAvailability: StoreAvailabilityConnection; + /** The product variant’s title. */ + title: Scalars['String']['output']; + /** The unit price value for the variant based on the variant's measurement. */ + unitPrice?: Maybe; + /** The unit price measurement for the variant. */ + unitPriceMeasurement?: Maybe; + /** The weight of the product variant in the unit system specified with `weight_unit`. */ + weight?: Maybe; + /** Unit of measurement for weight. */ + weightUnit: WeightUnit; +}; + + +/** + * A product variant represents a different version of a product, such as differing sizes or differing colors. + * + */ +export type ProductVariantMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** + * A product variant represents a different version of a product, such as differing sizes or differing colors. + * + */ +export type ProductVariantMetafieldsArgs = { + identifiers: Array; +}; + + +/** + * A product variant represents a different version of a product, such as differing sizes or differing colors. + * + */ +export type ProductVariantSellingPlanAllocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + + +/** + * A product variant represents a different version of a product, such as differing sizes or differing colors. + * + */ +export type ProductVariantStoreAvailabilityArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + near?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple ProductVariants. + * + */ +export type ProductVariantConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in ProductVariantEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one ProductVariant and a cursor during pagination. + * + */ +export type ProductVariantEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of ProductVariantEdge. */ + node: ProductVariant; +}; + +/** The set of valid sort keys for the ProductVariant query. */ +export type ProductVariantSortKeys = + /** Sort by the `id` value. */ + | 'ID' + /** Sort by the `position` value. */ + | 'POSITION' + /** + * Sort by relevance to the search terms when the `query` parameter is specified on the connection. + * Don't use this sort key when no search query is specified. + * + */ + | 'RELEVANCE' + /** Sort by the `sku` value. */ + | 'SKU' + /** Sort by the `title` value. */ + | 'TITLE'; + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRoot = { + /** Fetch a specific Article by its ID. */ + article?: Maybe
; + /** List of the shop's articles. */ + articles: ArticleConnection; + /** Fetch a specific `Blog` by one of its unique attributes. */ + blog?: Maybe; + /** + * Find a blog by its handle. + * @deprecated Use `blog` instead. + */ + blogByHandle?: Maybe; + /** List of the shop's blogs. */ + blogs: BlogConnection; + /** + * Retrieve a cart by its ID. For more information, refer to + * [Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage). + * + */ + cart?: Maybe; + /** + * A poll for the status of the cart checkout completion and order creation. + * + */ + cartCompletionAttempt?: Maybe; + /** Fetch a specific `Collection` by one of its unique attributes. */ + collection?: Maybe; + /** + * Find a collection by its handle. + * @deprecated Use `collection` instead. + */ + collectionByHandle?: Maybe; + /** List of the shop’s collections. */ + collections: CollectionConnection; + /** + * The customer associated with the given access token. Tokens are obtained by using the + * [`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate). + * + */ + customer?: Maybe; + /** Returns the localized experiences configured for the shop. */ + localization: Localization; + /** + * List of the shop's locations that support in-store pickup. + * + * When sorting by distance, you must specify a location via the `near` argument. + * + * + */ + locations: LocationConnection; + /** Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle. */ + menu?: Maybe; + /** Fetch a specific Metaobject by one of its unique identifiers. */ + metaobject?: Maybe; + /** All active metaobjects for the shop. */ + metaobjects: MetaobjectConnection; + /** Returns a specific node by ID. */ + node?: Maybe; + /** Returns the list of nodes with the given IDs. */ + nodes: Array>; + /** Fetch a specific `Page` by one of its unique attributes. */ + page?: Maybe; + /** + * Find a page by its handle. + * @deprecated Use `page` instead. + */ + pageByHandle?: Maybe; + /** List of the shop's pages. */ + pages: PageConnection; + /** List of the predictive search results. */ + predictiveSearch?: Maybe; + /** Fetch a specific `Product` by one of its unique attributes. */ + product?: Maybe; + /** + * Find a product by its handle. + * @deprecated Use `product` instead. + */ + productByHandle?: Maybe; + /** + * Find recommended products related to a given `product_id`. + * To learn more about how recommendations are generated, see + * [*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products). + * + */ + productRecommendations?: Maybe>; + /** + * Tags added to products. + * Additional access scope required: unauthenticated_read_product_tags. + * + */ + productTags: StringConnection; + /** List of product types for the shop's products that are published to your app. */ + productTypes: StringConnection; + /** List of the shop’s products. */ + products: ProductConnection; + /** The list of public Storefront API versions, including supported, release candidate and unstable versions. */ + publicApiVersions: Array; + /** List of the search results. */ + search: SearchResultItemConnection; + /** The shop associated with the storefront access token. */ + shop: Shop; + /** A list of redirects for a shop. */ + urlRedirects: UrlRedirectConnection; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootArticleArgs = { + id: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootArticlesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootBlogArgs = { + handle?: InputMaybe; + id?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootBlogByHandleArgs = { + handle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootBlogsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCartArgs = { + id: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCartCompletionAttemptArgs = { + attemptId: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionArgs = { + handle?: InputMaybe; + id?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionByHandleArgs = { + handle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCollectionsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootCustomerArgs = { + customerAccessToken: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootLocationsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + near?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMenuArgs = { + handle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectArgs = { + handle?: InputMaybe; + id?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootMetaobjectsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; + type: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootNodeArgs = { + id: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootNodesArgs = { + ids: Array; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPageArgs = { + handle?: InputMaybe; + id?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPageByHandleArgs = { + handle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPagesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootPredictiveSearchArgs = { + limit?: InputMaybe; + limitScope?: InputMaybe; + query: Scalars['String']['input']; + searchableFields?: InputMaybe>; + types?: InputMaybe>; + unavailableProducts?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductArgs = { + handle?: InputMaybe; + id?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductByHandleArgs = { + handle: Scalars['String']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductRecommendationsArgs = { + intent?: InputMaybe; + productId: Scalars['ID']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductTagsArgs = { + first: Scalars['Int']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductTypesArgs = { + first: Scalars['Int']['input']; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootSearchArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + prefix?: InputMaybe; + productFilters?: InputMaybe>; + query: Scalars['String']['input']; + reverse?: InputMaybe; + sortKey?: InputMaybe; + types?: InputMaybe>; + unavailableProducts?: InputMaybe; +}; + + +/** The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start. */ +export type QueryRootUrlRedirectsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + query?: InputMaybe; + reverse?: InputMaybe; +}; + +/** SEO information. */ +export type Seo = { + /** The meta description. */ + description?: Maybe; + /** The SEO title. */ + title?: Maybe; +}; + +/** + * Script discount applications capture the intentions of a discount that + * was created by a Shopify Script. + * + */ +export type ScriptDiscountApplication = DiscountApplication & { + /** The method by which the discount's value is allocated to its entitled items. */ + allocationMethod: DiscountApplicationAllocationMethod; + /** Which lines of targetType that the discount is allocated over. */ + targetSelection: DiscountApplicationTargetSelection; + /** The type of line that the discount is applicable towards. */ + targetType: DiscountApplicationTargetType; + /** The title of the application as defined by the Script. */ + title: Scalars['String']['output']; + /** The value of the discount application. */ + value: PricingValue; +}; + +/** Specifies whether to perform a partial word match on the last search term. */ +export type SearchPrefixQueryType = + /** Perform a partial word match on the last search term. */ + | 'LAST' + /** Don't perform a partial word match on the last search term. */ + | 'NONE'; + +/** A search query suggestion. */ +export type SearchQuerySuggestion = Trackable & { + /** The text of the search query suggestion with highlighted HTML tags. */ + styledText: Scalars['String']['output']; + /** The text of the search query suggestion. */ + text: Scalars['String']['output']; + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; +}; + +/** + * A search result that matches the search query. + * + */ +export type SearchResultItem = Article | Page | Product; + +/** + * An auto-generated type for paginating through multiple SearchResultItems. + * + */ +export type SearchResultItemConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SearchResultItemEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + /** A list of available filters. */ + productFilters: Array; + /** The total number of results. */ + totalCount: Scalars['Int']['output']; +}; + +/** + * An auto-generated type which holds one SearchResultItem and a cursor during pagination. + * + */ +export type SearchResultItemEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of SearchResultItemEdge. */ + node: SearchResultItem; +}; + +/** The set of valid sort keys for the search query. */ +export type SearchSortKeys = + /** Sort by the `price` value. */ + | 'PRICE' + /** Sort by relevance to the search terms. */ + | 'RELEVANCE'; + +/** The types of search items to perform search within. */ +export type SearchType = + /** Returns matching articles. */ + | 'ARTICLE' + /** Returns matching pages. */ + | 'PAGE' + /** Returns matching products. */ + | 'PRODUCT'; + +/** Specifies whether to display results for unavailable products. */ +export type SearchUnavailableProductsType = + /** Exclude unavailable products. */ + | 'HIDE' + /** Show unavailable products after all other matching results. This is the default. */ + | 'LAST' + /** Show unavailable products in the order that they're found. */ + | 'SHOW'; + +/** Specifies the list of resource fields to search. */ +export type SearchableField = + /** Author of the page or article. */ + | 'AUTHOR' + /** Body of the page or article or product description or collection description. */ + | 'BODY' + /** Product type. */ + | 'PRODUCT_TYPE' + /** Tag associated with the product or article. */ + | 'TAG' + /** Title of the page or article or product title or collection title. */ + | 'TITLE' + /** Variant barcode. */ + | 'VARIANTS_BARCODE' + /** Variant SKU. */ + | 'VARIANTS_SKU' + /** Variant title. */ + | 'VARIANTS_TITLE' + /** Product vendor. */ + | 'VENDOR'; + +/** + * Properties used by customers to select a product variant. + * Products can have multiple options, like different sizes or colors. + * + */ +export type SelectedOption = { + /** The product option’s name. */ + name: Scalars['String']['output']; + /** The product option’s value. */ + value: Scalars['String']['output']; +}; + +/** The input fields required for a selected option. */ +export type SelectedOptionInput = { + /** The product option’s name. */ + name: Scalars['String']['input']; + /** The product option’s value. */ + value: Scalars['String']['input']; +}; + +/** Represents how products and variants can be sold and purchased. */ +export type SellingPlan = { + /** The initial payment due for the purchase. */ + checkoutCharge: SellingPlanCheckoutCharge; + /** The description of the selling plan. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'. */ + name: Scalars['String']['output']; + /** The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. */ + options: Array; + /** The price adjustments that a selling plan makes when a variant is purchased with a selling plan. */ + priceAdjustments: Array; + /** Whether purchasing the selling plan will result in multiple deliveries. */ + recurringDeliveries: Scalars['Boolean']['output']; +}; + +/** Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan. */ +export type SellingPlanAllocation = { + /** The checkout charge amount due for the purchase. */ + checkoutChargeAmount: MoneyV2; + /** A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it. */ + priceAdjustments: Array; + /** The remaining balance charge amount due for the purchase. */ + remainingBalanceChargeAmount: MoneyV2; + /** A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */ + sellingPlan: SellingPlan; +}; + +/** + * An auto-generated type for paginating through multiple SellingPlanAllocations. + * + */ +export type SellingPlanAllocationConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SellingPlanAllocationEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination. + * + */ +export type SellingPlanAllocationEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of SellingPlanAllocationEdge. */ + node: SellingPlanAllocation; +}; + +/** The resulting prices for variants when they're purchased with a specific selling plan. */ +export type SellingPlanAllocationPriceAdjustment = { + /** The price of the variant when it's purchased without a selling plan for the same number of deliveries. For example, if a customer purchases 6 deliveries of $10.00 granola separately, then the price is 6 x $10.00 = $60.00. */ + compareAtPrice: MoneyV2; + /** The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00. */ + perDeliveryPrice: MoneyV2; + /** The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00. */ + price: MoneyV2; + /** The resulting price per unit for the variant associated with the selling plan. If the variant isn't sold by quantity or measurement, then this field returns `null`. */ + unitPrice?: Maybe; +}; + +/** The initial payment due for the purchase. */ +export type SellingPlanCheckoutCharge = { + /** The charge type for the checkout charge. */ + type: SellingPlanCheckoutChargeType; + /** The charge value for the checkout charge. */ + value: SellingPlanCheckoutChargeValue; +}; + +/** The percentage value of the price used for checkout charge. */ +export type SellingPlanCheckoutChargePercentageValue = { + /** The percentage value of the price used for checkout charge. */ + percentage: Scalars['Float']['output']; +}; + +/** The checkout charge when the full amount isn't charged at checkout. */ +export type SellingPlanCheckoutChargeType = + /** The checkout charge is a percentage of the product or variant price. */ + | 'PERCENTAGE' + /** The checkout charge is a fixed price amount. */ + | 'PRICE'; + +/** The portion of the price to be charged at checkout. */ +export type SellingPlanCheckoutChargeValue = MoneyV2 | SellingPlanCheckoutChargePercentageValue; + +/** + * An auto-generated type for paginating through multiple SellingPlans. + * + */ +export type SellingPlanConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SellingPlanEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SellingPlan and a cursor during pagination. + * + */ +export type SellingPlanEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of SellingPlanEdge. */ + node: SellingPlan; +}; + +/** A fixed amount that's deducted from the original variant price. For example, $10.00 off. */ +export type SellingPlanFixedAmountPriceAdjustment = { + /** The money value of the price adjustment. */ + adjustmentAmount: MoneyV2; +}; + +/** A fixed price adjustment for a variant that's purchased with a selling plan. */ +export type SellingPlanFixedPriceAdjustment = { + /** A new price of the variant when it's purchased with the selling plan. */ + price: MoneyV2; +}; + +/** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ +export type SellingPlanGroup = { + /** A display friendly name for the app that created the selling plan group. */ + appName?: Maybe; + /** The name of the selling plan group. */ + name: Scalars['String']['output']; + /** Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. */ + options: Array; + /** A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'. */ + sellingPlans: SellingPlanConnection; +}; + + +/** Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans. */ +export type SellingPlanGroupSellingPlansArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + reverse?: InputMaybe; +}; + +/** + * An auto-generated type for paginating through multiple SellingPlanGroups. + * + */ +export type SellingPlanGroupConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in SellingPlanGroupEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one SellingPlanGroup and a cursor during pagination. + * + */ +export type SellingPlanGroupEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of SellingPlanGroupEdge. */ + node: SellingPlanGroup; +}; + +/** + * Represents an option on a selling plan group that's available in the drop-down list in the storefront. + * + * Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing. + */ +export type SellingPlanGroupOption = { + /** The name of the option. For example, 'Delivery every'. */ + name: Scalars['String']['output']; + /** The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'. */ + values: Array; +}; + +/** An option provided by a Selling Plan. */ +export type SellingPlanOption = { + /** The name of the option (ie "Delivery every"). */ + name?: Maybe; + /** The value of the option (ie "Month"). */ + value?: Maybe; +}; + +/** A percentage amount that's deducted from the original variant price. For example, 10% off. */ +export type SellingPlanPercentagePriceAdjustment = { + /** The percentage value of the price adjustment. */ + adjustmentPercentage: Scalars['Int']['output']; +}; + +/** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price. */ +export type SellingPlanPriceAdjustment = { + /** The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price. */ + adjustmentValue: SellingPlanPriceAdjustmentValue; + /** The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`. */ + orderCount?: Maybe; +}; + +/** Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. */ +export type SellingPlanPriceAdjustmentValue = SellingPlanFixedAmountPriceAdjustment | SellingPlanFixedPriceAdjustment | SellingPlanPercentagePriceAdjustment; + +/** A shipping rate to be applied to a checkout. */ +export type ShippingRate = { + /** Human-readable unique identifier for this shipping rate. */ + handle: Scalars['String']['output']; + /** Price of this shipping rate. */ + price: MoneyV2; + /** + * Price of this shipping rate. + * @deprecated Use `price` instead. + */ + priceV2: MoneyV2; + /** Title of this shipping rate. */ + title: Scalars['String']['output']; +}; + +/** Shop represents a collection of the general settings and information about the shop. */ +export type Shop = HasMetafields & Node & { + /** The shop's branding configuration. */ + brand?: Maybe; + /** A description of the shop. */ + description?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Returns a metafield found by namespace and key. */ + metafield?: Maybe; + /** The metafields associated with the resource matching the supplied list of namespaces and keys. */ + metafields: Array>; + /** A string representing the way currency is formatted when the currency isn’t specified. */ + moneyFormat: Scalars['String']['output']; + /** The shop’s name. */ + name: Scalars['String']['output']; + /** Settings related to payments. */ + paymentSettings: PaymentSettings; + /** The primary domain of the shop’s Online Store. */ + primaryDomain: Domain; + /** The shop’s privacy policy. */ + privacyPolicy?: Maybe; + /** The shop’s refund policy. */ + refundPolicy?: Maybe; + /** The shop’s shipping policy. */ + shippingPolicy?: Maybe; + /** Countries that the shop ships to. */ + shipsToCountries: Array; + /** The shop’s subscription policy. */ + subscriptionPolicy?: Maybe; + /** The shop’s terms of service. */ + termsOfService?: Maybe; +}; + + +/** Shop represents a collection of the general settings and information about the shop. */ +export type ShopMetafieldArgs = { + key: Scalars['String']['input']; + namespace: Scalars['String']['input']; +}; + + +/** Shop represents a collection of the general settings and information about the shop. */ +export type ShopMetafieldsArgs = { + identifiers: Array; +}; + +/** + * The input fields for submitting Shop Pay payment method information for checkout. + * + */ +export type ShopPayWalletContentInput = { + /** The customer's billing address. */ + billingAddress: MailingAddressInput; + /** Session token for transaction. */ + sessionToken: Scalars['String']['input']; +}; + +/** Policy that a merchant has configured for their store, such as their refund or privacy policy. */ +export type ShopPolicy = Node & { + /** Policy text, maximum size of 64kb. */ + body: Scalars['String']['output']; + /** Policy’s handle. */ + handle: Scalars['String']['output']; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** Policy’s title. */ + title: Scalars['String']['output']; + /** Public URL to the policy. */ + url: Scalars['URL']['output']; +}; + +/** + * A policy for the store that comes with a default value, such as a subscription policy. + * If the merchant hasn't configured a policy for their store, then the policy will return the default value. + * Otherwise, the policy will return the merchant-configured value. + * + */ +export type ShopPolicyWithDefault = { + /** The text of the policy. Maximum size: 64KB. */ + body: Scalars['String']['output']; + /** The handle of the policy. */ + handle: Scalars['String']['output']; + /** The unique ID of the policy. A default policy doesn't have an ID. */ + id?: Maybe; + /** The title of the policy. */ + title: Scalars['String']['output']; + /** Public URL to the policy. */ + url: Scalars['URL']['output']; +}; + +/** + * The availability of a product variant at a particular location. + * Local pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result. + * + */ +export type StoreAvailability = { + /** Whether the product variant is in-stock at this location. */ + available: Scalars['Boolean']['output']; + /** The location where this product variant is stocked at. */ + location: Location; + /** Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours). */ + pickUpTime: Scalars['String']['output']; + /** The quantity of the product variant in-stock at this location. */ + quantityAvailable: Scalars['Int']['output']; +}; + +/** + * An auto-generated type for paginating through multiple StoreAvailabilities. + * + */ +export type StoreAvailabilityConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in StoreAvailabilityEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one StoreAvailability and a cursor during pagination. + * + */ +export type StoreAvailabilityEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of StoreAvailabilityEdge. */ + node: StoreAvailability; +}; + +/** + * An auto-generated type for paginating through a list of Strings. + * + */ +export type StringConnection = { + /** A list of edges. */ + edges: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one String and a cursor during pagination. + * + */ +export type StringEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of StringEdge. */ + node: Scalars['String']['output']; +}; + +/** An error that occurred during cart submit for completion. */ +export type SubmissionError = { + /** The error code. */ + code: SubmissionErrorCode; + /** The error message. */ + message?: Maybe; +}; + +/** The code of the error that occurred during cart submit for completion. */ +export type SubmissionErrorCode = + | 'BUYER_IDENTITY_EMAIL_IS_INVALID' + | 'BUYER_IDENTITY_EMAIL_REQUIRED' + | 'BUYER_IDENTITY_PHONE_IS_INVALID' + | 'DELIVERY_ADDRESS1_INVALID' + | 'DELIVERY_ADDRESS1_REQUIRED' + | 'DELIVERY_ADDRESS1_TOO_LONG' + | 'DELIVERY_ADDRESS2_INVALID' + | 'DELIVERY_ADDRESS2_REQUIRED' + | 'DELIVERY_ADDRESS2_TOO_LONG' + | 'DELIVERY_ADDRESS_REQUIRED' + | 'DELIVERY_CITY_INVALID' + | 'DELIVERY_CITY_REQUIRED' + | 'DELIVERY_CITY_TOO_LONG' + | 'DELIVERY_COMPANY_INVALID' + | 'DELIVERY_COMPANY_REQUIRED' + | 'DELIVERY_COMPANY_TOO_LONG' + | 'DELIVERY_COUNTRY_REQUIRED' + | 'DELIVERY_FIRST_NAME_INVALID' + | 'DELIVERY_FIRST_NAME_REQUIRED' + | 'DELIVERY_FIRST_NAME_TOO_LONG' + | 'DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY' + | 'DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE' + | 'DELIVERY_LAST_NAME_INVALID' + | 'DELIVERY_LAST_NAME_REQUIRED' + | 'DELIVERY_LAST_NAME_TOO_LONG' + | 'DELIVERY_NO_DELIVERY_AVAILABLE' + | 'DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE' + | 'DELIVERY_OPTIONS_PHONE_NUMBER_INVALID' + | 'DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED' + | 'DELIVERY_PHONE_NUMBER_INVALID' + | 'DELIVERY_PHONE_NUMBER_REQUIRED' + | 'DELIVERY_POSTAL_CODE_INVALID' + | 'DELIVERY_POSTAL_CODE_REQUIRED' + | 'DELIVERY_ZONE_NOT_FOUND' + | 'DELIVERY_ZONE_REQUIRED_FOR_COUNTRY' + | 'ERROR' + | 'MERCHANDISE_LINE_LIMIT_REACHED' + | 'MERCHANDISE_NOT_APPLICABLE' + | 'MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE' + | 'MERCHANDISE_OUT_OF_STOCK' + | 'MERCHANDISE_PRODUCT_NOT_PUBLISHED' + | 'NO_DELIVERY_GROUP_SELECTED' + | 'PAYMENTS_ADDRESS1_INVALID' + | 'PAYMENTS_ADDRESS1_REQUIRED' + | 'PAYMENTS_ADDRESS1_TOO_LONG' + | 'PAYMENTS_ADDRESS2_INVALID' + | 'PAYMENTS_ADDRESS2_REQUIRED' + | 'PAYMENTS_ADDRESS2_TOO_LONG' + | 'PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND' + | 'PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY' + | 'PAYMENTS_CITY_INVALID' + | 'PAYMENTS_CITY_REQUIRED' + | 'PAYMENTS_CITY_TOO_LONG' + | 'PAYMENTS_COMPANY_INVALID' + | 'PAYMENTS_COMPANY_REQUIRED' + | 'PAYMENTS_COMPANY_TOO_LONG' + | 'PAYMENTS_COUNTRY_REQUIRED' + | 'PAYMENTS_CREDIT_CARD_BASE_EXPIRED' + | 'PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED' + | 'PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT' + | 'PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED' + | 'PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK' + | 'PAYMENTS_CREDIT_CARD_GENERIC' + | 'PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK' + | 'PAYMENTS_CREDIT_CARD_MONTH_INCLUSION' + | 'PAYMENTS_CREDIT_CARD_NAME_INVALID' + | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID' + | 'PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT' + | 'PAYMENTS_CREDIT_CARD_SESSION_ID' + | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK' + | 'PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE' + | 'PAYMENTS_CREDIT_CARD_YEAR_EXPIRED' + | 'PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR' + | 'PAYMENTS_FIRST_NAME_INVALID' + | 'PAYMENTS_FIRST_NAME_REQUIRED' + | 'PAYMENTS_FIRST_NAME_TOO_LONG' + | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY' + | 'PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE' + | 'PAYMENTS_LAST_NAME_INVALID' + | 'PAYMENTS_LAST_NAME_REQUIRED' + | 'PAYMENTS_LAST_NAME_TOO_LONG' + | 'PAYMENTS_METHOD_REQUIRED' + | 'PAYMENTS_METHOD_UNAVAILABLE' + | 'PAYMENTS_PHONE_NUMBER_INVALID' + | 'PAYMENTS_PHONE_NUMBER_REQUIRED' + | 'PAYMENTS_POSTAL_CODE_INVALID' + | 'PAYMENTS_POSTAL_CODE_REQUIRED' + | 'PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED' + | 'PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT' + | 'PAYMENTS_WALLET_CONTENT_MISSING' + | 'TAXES_DELIVERY_GROUP_ID_NOT_FOUND' + | 'TAXES_LINE_ID_NOT_FOUND' + | 'TAXES_MUST_BE_DEFINED'; + +/** Cart submit for checkout completion is successful. */ +export type SubmitAlreadyAccepted = { + /** The ID of the cart completion attempt that will be used for polling for the result. */ + attemptId: Scalars['String']['output']; +}; + +/** Cart submit for checkout completion failed. */ +export type SubmitFailed = { + /** The URL of the checkout for the cart. */ + checkoutUrl?: Maybe; + /** The list of errors that occurred from executing the mutation. */ + errors: Array; +}; + +/** Cart submit for checkout completion is already accepted. */ +export type SubmitSuccess = { + /** The ID of the cart completion attempt that will be used for polling for the result. */ + attemptId: Scalars['String']['output']; +}; + +/** Cart submit for checkout completion is throttled. */ +export type SubmitThrottled = { + /** + * UTC date time string that indicates the time after which clients should make their next + * poll request. Any poll requests sent before this time will be ignored. Use this value to schedule the + * next poll request. + * + */ + pollAfter: Scalars['DateTime']['output']; +}; + +/** + * Specifies the fields required to complete a checkout with + * a tokenized payment. + * + */ +export type TokenizedPaymentInputV3 = { + /** The billing address for the payment. */ + billingAddress: MailingAddressInput; + /** A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests). */ + idempotencyKey: Scalars['String']['input']; + /** Public Hash Key used for AndroidPay payments only. */ + identifier?: InputMaybe; + /** The amount and currency of the payment. */ + paymentAmount: MoneyInput; + /** A simple string or JSON containing the required payment data for the tokenized payment. */ + paymentData: Scalars['String']['input']; + /** Whether to execute the payment in test mode, if possible. Test mode isn't supported in production stores. Defaults to `false`. */ + test?: InputMaybe; + /** The type of payment token. */ + type: PaymentTokenType; +}; + +/** Represents a resource that you can track the origin of the search traffic. */ +export type Trackable = { + /** A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic. */ + trackingParameters?: Maybe; +}; + +/** An object representing exchange of money for a product or service. */ +export type Transaction = { + /** The amount of money that the transaction was for. */ + amount: MoneyV2; + /** + * The amount of money that the transaction was for. + * @deprecated Use `amount` instead. + */ + amountV2: MoneyV2; + /** The kind of the transaction. */ + kind: TransactionKind; + /** + * The status of the transaction. + * @deprecated Use `statusV2` instead. + */ + status: TransactionStatus; + /** The status of the transaction. */ + statusV2?: Maybe; + /** Whether the transaction was done in test mode or not. */ + test: Scalars['Boolean']['output']; +}; + +/** The different kinds of order transactions. */ +export type TransactionKind = + /** + * An amount reserved against the cardholder's funding source. + * Money does not change hands until the authorization is captured. + * + */ + | 'AUTHORIZATION' + /** A transfer of the money that was reserved during the authorization stage. */ + | 'CAPTURE' + /** Money returned to the customer when they have paid too much. */ + | 'CHANGE' + /** An authorization for a payment taken with an EMV credit card reader. */ + | 'EMV_AUTHORIZATION' + /** An authorization and capture performed together in a single step. */ + | 'SALE'; + +/** Transaction statuses describe the status of a transaction. */ +export type TransactionStatus = + /** There was an error while processing the transaction. */ + | 'ERROR' + /** The transaction failed. */ + | 'FAILURE' + /** The transaction is pending. */ + | 'PENDING' + /** The transaction succeeded. */ + | 'SUCCESS'; + +/** + * The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml). + * + */ +export type UnitPriceMeasurement = { + /** The type of unit of measurement for the unit price measurement. */ + measuredType?: Maybe; + /** The quantity unit for the unit price measurement. */ + quantityUnit?: Maybe; + /** The quantity value for the unit price measurement. */ + quantityValue: Scalars['Float']['output']; + /** The reference unit for the unit price measurement. */ + referenceUnit?: Maybe; + /** The reference value for the unit price measurement. */ + referenceValue: Scalars['Int']['output']; +}; + +/** The accepted types of unit of measurement. */ +export type UnitPriceMeasurementMeasuredType = + /** Unit of measurements representing areas. */ + | 'AREA' + /** Unit of measurements representing lengths. */ + | 'LENGTH' + /** Unit of measurements representing volumes. */ + | 'VOLUME' + /** Unit of measurements representing weights. */ + | 'WEIGHT'; + +/** The valid units of measurement for a unit price measurement. */ +export type UnitPriceMeasurementMeasuredUnit = + /** 100 centiliters equals 1 liter. */ + | 'CL' + /** 100 centimeters equals 1 meter. */ + | 'CM' + /** Metric system unit of weight. */ + | 'G' + /** 1 kilogram equals 1000 grams. */ + | 'KG' + /** Metric system unit of volume. */ + | 'L' + /** Metric system unit of length. */ + | 'M' + /** Metric system unit of area. */ + | 'M2' + /** 1 cubic meter equals 1000 liters. */ + | 'M3' + /** 1000 milligrams equals 1 gram. */ + | 'MG' + /** 1000 milliliters equals 1 liter. */ + | 'ML' + /** 1000 millimeters equals 1 meter. */ + | 'MM'; + +/** Systems of weights and measures. */ +export type UnitSystem = + /** Imperial system of weights and measures. */ + | 'IMPERIAL_SYSTEM' + /** Metric system of weights and measures. */ + | 'METRIC_SYSTEM'; + +/** A redirect on the online store. */ +export type UrlRedirect = Node & { + /** The ID of the URL redirect. */ + id: Scalars['ID']['output']; + /** The old path to be redirected from. When the user visits this path, they'll be redirected to the target location. */ + path: Scalars['String']['output']; + /** The target location where the user will be redirected to. */ + target: Scalars['String']['output']; +}; + +/** + * An auto-generated type for paginating through multiple UrlRedirects. + * + */ +export type UrlRedirectConnection = { + /** A list of edges. */ + edges: Array; + /** A list of the nodes contained in UrlRedirectEdge. */ + nodes: Array; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** + * An auto-generated type which holds one UrlRedirect and a cursor during pagination. + * + */ +export type UrlRedirectEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of UrlRedirectEdge. */ + node: UrlRedirect; +}; + +/** Represents an error in the input of a mutation. */ +export type UserError = DisplayableError & { + /** The path to the input field that caused the error. */ + field?: Maybe>; + /** The error message. */ + message: Scalars['String']['output']; +}; + +/** The input fields for a filter used to view a subset of products in a collection matching a specific variant option. */ +export type VariantOptionFilter = { + /** The name of the variant option to filter on. */ + name: Scalars['String']['input']; + /** The value of the variant option to filter on. */ + value: Scalars['String']['input']; +}; + +/** Represents a Shopify hosted video. */ +export type Video = Media & Node & { + /** A word or phrase to share the nature or contents of a media. */ + alt?: Maybe; + /** A globally-unique ID. */ + id: Scalars['ID']['output']; + /** The media content type. */ + mediaContentType: MediaContentType; + /** The presentation for a media. */ + presentation?: Maybe; + /** The preview image for the media. */ + previewImage?: Maybe; + /** The sources for a video. */ + sources: Array; +}; + +/** Represents a source for a Shopify hosted video. */ +export type VideoSource = { + /** The format of the video source. */ + format: Scalars['String']['output']; + /** The height of the video. */ + height: Scalars['Int']['output']; + /** The video MIME type. */ + mimeType: Scalars['String']['output']; + /** The URL of the video. */ + url: Scalars['String']['output']; + /** The width of the video. */ + width: Scalars['Int']['output']; +}; + +/** Units of measurement for weight. */ +export type WeightUnit = + /** Metric system unit of mass. */ + | 'GRAMS' + /** 1 kilogram equals 1000 grams. */ + | 'KILOGRAMS' + /** Imperial system unit of mass. */ + | 'OUNCES' + /** 1 pound equals 16 ounces. */ + | 'POUNDS'; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; + + +export type CreateCartMutation = { payload?: { cart?: { id: string } | null } | null }; diff --git a/shopify/utils/introspection.graphql.json b/shopify/utils/introspection.graphql.json new file mode 100644 index 000000000..3e4fbdea0 --- /dev/null +++ b/shopify/utils/introspection.graphql.json @@ -0,0 +1,35174 @@ +{ + "data": { + "__schema": { + "queryType": { + "name": "QueryRoot" + }, + "mutationType": { + "name": "Mutation" + }, + "subscriptionType": null, + "types": [ + { + "kind": "OBJECT", + "name": "ApiVersion", + "description": "A version of the API, as defined by [Shopify API versioning](https://shopify.dev/api/usage/versioning).\nVersions are commonly referred to by their handle (for example, `2021-10`).\n", + "fields": [ + { + "name": "displayName", + "description": "The human-readable name of the version.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique identifier of an ApiVersion. All supported API versions have a date-based (YYYY-MM) or `unstable` handle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supported", + "description": "Whether the version is actively supported by Shopify. Supported API versions\nare guaranteed to be stable. Unsupported API versions include unstable,\nrelease candidate, and end-of-life versions that are marked as unsupported.\nFor more information, refer to\n[Versioning](https://shopify.dev/api/usage/versioning).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplePayWalletContentInput", + "description": "The input fields for submitting Apple Pay payment method information for checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "billingAddress", + "description": "The customer's billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "data", + "description": "The data for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "header", + "description": "The header data for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ApplePayWalletHeaderInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lastDigits", + "description": "The last digits of the card used to create the payment.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "signature", + "description": "The signature for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "version", + "description": "The version for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ApplePayWalletHeaderInput", + "description": "The input fields for submitting wallet payment method information for checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "applicationData", + "description": "The application data for the Apple Pay wallet.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "ephemeralPublicKey", + "description": "The ephemeral public key for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "publicKeyHash", + "description": "The public key hash for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "transactionId", + "description": "The transaction ID for the Apple Pay wallet.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AppliedGiftCard", + "description": "Details about the gift card used on the checkout.", + "fields": [ + { + "name": "amountUsed", + "description": "The amount that was taken from the gift card by applying it.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountUsedV2", + "description": "The amount that was taken from the gift card by applying it.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amountUsed` instead." + }, + { + "name": "balance", + "description": "The amount left on the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "balanceV2", + "description": "The amount left on the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `balance` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastCharacters", + "description": "The last characters of the gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentmentAmountUsed", + "description": "The amount that was applied to the checkout in its currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Article", + "description": "An article in an online store blog.", + "fields": [ + { + "name": "author", + "description": "The article's author.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ArticleAuthor", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `authorV2` instead." + }, + { + "name": "authorV2", + "description": "The article's author.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ArticleAuthor", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "blog", + "description": "The blog that the article belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "comments", + "description": "List of comments posted on the article.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CommentConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content", + "description": "Stripped content of the article, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contentHtml", + "description": "The content of the article, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "excerpt", + "description": "Stripped excerpt of the article, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "excerptHtml", + "description": "The excerpt of the article, complete with HTML formatting.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A human-friendly unique string for the Article automatically generated from its title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image associated with the article.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedAt", + "description": "The date and time when the article was published.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "The article’s SEO information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A categorization that a article can be tagged with.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The article’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Trackable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ArticleAuthor", + "description": "The author of an article.", + "fields": [ + { + "name": "bio", + "description": "The author's bio.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The author’s email.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The author's first name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The author's last name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The author's full name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ArticleConnection", + "description": "An auto-generated type for paginating through multiple Articles.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ArticleEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ArticleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Article", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ArticleEdge", + "description": "An auto-generated type which holds one Article and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ArticleEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Article", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ArticleSortKeys", + "description": "The set of valid sort keys for the Article query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLOG_TITLE", + "description": "Sort by the `blog_title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHOR", + "description": "Sort by the `author` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PUBLISHED_AT", + "description": "Sort by the `published_at` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Attribute", + "description": "Represents a generic custom attribute.", + "fields": [ + { + "name": "key", + "description": "Key or name of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "description": "The input fields for an attribute.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "Key or name of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "Value of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AutomaticDiscountApplication", + "description": "Automatic discount applications capture the intentions of a discount that was automatically applied.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "Which lines of targetType that the discount is allocated over.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of line that the discount is applicable towards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AvailableShippingRates", + "description": "A collection of available shipping rates for a checkout.", + "fields": [ + { + "name": "ready", + "description": "Whether or not the shipping rates are ready.\nThe `shippingRates` field is `null` when this value is `false`.\nThis field should be polled until its value becomes `true`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingRates", + "description": "The fetched shipping rates. `null` until the `ready` field is `true`.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingRate", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "BaseCartLine", + "description": "An object with an ID field to support global identification, in accordance with the\n[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).\nThis interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)\nand [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.\n", + "fields": [ + { + "name": "attribute", + "description": "An attribute associated with the cart line.", + "args": [ + { + "name": "key", + "description": "The key of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The attributes associated with the cart line. Attributes are represented as key-value pairs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cost", + "description": "The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineCost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedCost", + "description": "The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineEstimatedCost", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `cost` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchandise", + "description": "The merchandise that the buyer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "Merchandise", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the merchandise that the customer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanAllocation", + "description": "The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CartLine", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ComponentizableCartLine", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "BaseCartLineConnection", + "description": "An auto-generated type for paginating through multiple BaseCartLines.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BaseCartLineEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in BaseCartLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "BaseCartLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BaseCartLineEdge", + "description": "An auto-generated type which holds one BaseCartLine and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of BaseCartLineEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "BaseCartLine", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "description": "An online store blog.", + "fields": [ + { + "name": "articleByHandle", + "description": "Find an article by its handle.", + "args": [ + { + "name": "handle", + "description": "The handle of the article.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "articles", + "description": "List of the blog's articles.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ArticleSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `author`\n - `blog_title`\n - `created_at`\n - `tag`\n - `tag_not`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ArticleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "authors", + "description": "The authors who have contributed to the blog.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ArticleAuthor", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A human-friendly unique string for the Blog automatically generated from its title.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "The blog's SEO information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The blogs’s title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BlogConnection", + "description": "An auto-generated type for paginating through multiple Blogs.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BlogEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in BlogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BlogEdge", + "description": "An auto-generated type which holds one Blog and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of BlogEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BlogSortKeys", + "description": "The set of valid sort keys for the Blog query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HANDLE", + "description": "Sort by the `handle` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Boolean", + "description": "Represents `true` or `false` values.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Brand", + "description": "The store's [branding configuration](https://help.shopify.com/en/manual/promoting-marketing/managing-brand-assets).\n", + "fields": [ + { + "name": "colors", + "description": "The colors of the store's brand.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BrandColors", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "coverImage", + "description": "The store's cover image.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logo", + "description": "The store's default logo.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shortDescription", + "description": "The store's short description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "slogan", + "description": "The store's slogan.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "squareLogo", + "description": "The store's preferred logo for square UI elements.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BrandColorGroup", + "description": "A group of related colors for the shop's brand.\n", + "fields": [ + { + "name": "background", + "description": "The background color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Color", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "foreground", + "description": "The foreground color.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Color", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BrandColors", + "description": "The colors of the shop's brand.\n", + "fields": [ + { + "name": "primary", + "description": "The shop's primary brand colors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BrandColorGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secondary", + "description": "The shop's secondary brand colors.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BrandColorGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CardBrand", + "description": "Card brand, such as Visa or Mastercard, which can be used for payments.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VISA", + "description": "Visa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MASTERCARD", + "description": "Mastercard.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOVER", + "description": "Discover.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMERICAN_EXPRESS", + "description": "American Express.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DINERS_CLUB", + "description": "Diners Club.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JCB", + "description": "JCB.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Cart", + "description": "A cart represents the merchandise that a buyer intends to purchase,\nand the estimated cost associated with the cart. Learn how to\n[interact with a cart](https://shopify.dev/custom-storefronts/internationalization/international-pricing)\nduring a customer's session.\n", + "fields": [ + { + "name": "attribute", + "description": "An attribute associated with the cart.", + "args": [ + { + "name": "key", + "description": "The key of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The attributes associated with the cart. Attributes are represented as key-value pairs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyerIdentity", + "description": "Information about the buyer that's interacting with the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartBuyerIdentity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUrl", + "description": "The URL of the checkout for the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cost", + "description": "The estimated costs that the buyer will pay at checkout. The costs are subject\nto change and changes will be reflected at checkout. The `cost` field uses the\n`buyerIdentity` field to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartCost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the cart was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryGroups", + "description": "The delivery groups available for the cart, based on the buyer identity default\ndelivery address preference or the default address of the logged-in customer.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDeliveryGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been applied to the entire cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountCodes", + "description": "The case-insensitive discount codes that the customer added at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDiscountCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedCost", + "description": "The estimated costs that the buyer will pay at checkout.\nThe estimated costs are subject to change and changes will be reflected at checkout.\nThe `estimatedCost` field uses the `buyerIdentity` field to determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartEstimatedCost", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `cost` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lines", + "description": "A list of lines containing information about the items the customer intends to purchase.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BaseCartLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "A note that's associated with the cart. For example, the note can be a personalized message to the buyer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalQuantity", + "description": "The total number of items in the cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the cart was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartAttributesUpdatePayload", + "description": "Return type for `cartAttributesUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartAutomaticDiscountAllocation", + "description": "The discounts automatically applied to the cart line based on prerequisites that have been met.", + "fields": [ + { + "name": "discountedAmount", + "description": "The discounted amount that has been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the allocated discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartBuyerIdentity", + "description": "Represents information about the buyer that is interacting with the cart.", + "fields": [ + { + "name": "countryCode", + "description": "The country where the buyer is located.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer account associated with the cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryAddressPreferences", + "description": "An ordered set of delivery addresses tied to the buyer that is interacting with the cart.\nThe rank of the preferences is determined by the order of the addresses in the array. Preferences\ncan be used to populate relevant fields in the checkout flow.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "DeliveryAddress", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the buyer that's interacting with the cart.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the buyer that's interacting with the cart.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "walletPreferences", + "description": "A set of wallet preferences tied to the buyer that is interacting with the cart.\nPreferences can be used to populate relevant payment fields in the checkout flow.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartBuyerIdentityInput", + "description": "Specifies the input fields to update the buyer information associated with a cart.\nBuyer identity is used to determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing)\nand should match the customer's shipping address.\n", + "fields": null, + "inputFields": [ + { + "name": "countryCode", + "description": "The country where the buyer is located.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer associated with the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryAddressPreferences", + "description": "An ordered set of delivery addresses tied to the buyer that is interacting with the cart.\nThe rank of the preferences is determined by the order of the addresses in the array. Preferences\ncan be used to populate relevant fields in the checkout flow.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "DeliveryAddressInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email address of the buyer that is interacting with the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "The phone number of the buyer that is interacting with the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "walletPreferences", + "description": "A set of wallet preferences tied to the buyer that is interacting with the cart.\nPreferences can be used to populate relevant payment fields in the checkout flow.\n Accepted value: `[\"shop_pay\"]`.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartBuyerIdentityUpdatePayload", + "description": "Return type for `cartBuyerIdentityUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartCardSource", + "description": "Represents how credit card details are provided for a direct payment.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SAVED_CREDIT_CARD", + "description": "The credit card was provided by a third party and vaulted on their system.\nUsing this value requires a separate permission from Shopify.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCodeDiscountAllocation", + "description": "The discount that has been applied to the cart line using a discount code.", + "fields": [ + { + "name": "code", + "description": "The code used to apply the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedAmount", + "description": "The discounted amount that has been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CartCompletionAction", + "description": "The completion action to checkout a cart.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CompletePaymentChallenge", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CartCompletionActionRequired", + "description": "The required completion action to checkout a cart.", + "fields": [ + { + "name": "action", + "description": "The action required to complete the cart completion attempt.", + "args": [], + "type": { + "kind": "UNION", + "name": "CartCompletionAction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the cart completion attempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CartCompletionAttemptResult", + "description": "The result of a cart completion attempt.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CartCompletionActionRequired", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartCompletionFailed", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartCompletionProcessing", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartCompletionSuccess", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CartCompletionFailed", + "description": "A failed completion to checkout a cart.", + "fields": [ + { + "name": "errors", + "description": "The errors that caused the checkout to fail.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompletionError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the cart completion attempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCompletionProcessing", + "description": "A cart checkout completion that's still processing.", + "fields": [ + { + "name": "id", + "description": "The ID of the cart completion attempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pollDelay", + "description": "The number of milliseconds to wait before polling again.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCompletionSuccess", + "description": "A successful completion to checkout a cart and a created order.", + "fields": [ + { + "name": "completedAt", + "description": "The date and time when the job completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID of the cart completion attempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderId", + "description": "The ID of the order that's created in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderUrl", + "description": "The URL of the order confirmation in Shopify.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCost", + "description": "The costs that the buyer will pay at checkout.\nThe cart cost uses [`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity) to determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).\n", + "fields": [ + { + "name": "checkoutChargeAmount", + "description": "The estimated amount, before taxes and discounts, for the customer to pay at\ncheckout. The checkout charge amount doesn't include any deferred payments\nthat'll be paid at a later date. If the cart has no deferred payments, then\nthe checkout charge amount is equivalent to `subtotalAmount`.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalAmount", + "description": "The amount, before taxes and cart-level discounts, for the customer to pay.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalAmountEstimated", + "description": "Whether the subtotal amount is estimated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total amount for the customer to pay.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmountEstimated", + "description": "Whether the total amount is estimated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDutyAmount", + "description": "The duty amount for the customer to pay at checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDutyAmountEstimated", + "description": "Whether the total duty amount is estimated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The tax amount for the customer to pay at checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmountEstimated", + "description": "Whether the total tax amount is estimated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCreatePayload", + "description": "Return type for `cartCreate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The new cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartCustomDiscountAllocation", + "description": "The discounts automatically applied to the cart line based on prerequisites that have been met.", + "fields": [ + { + "name": "discountedAmount", + "description": "The discounted amount that has been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the allocated discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDeliveryGroup", + "description": "Information about the options available for one or more line items to be delivered to a specific address.", + "fields": [ + { + "name": "cartLines", + "description": "A list of cart lines for the delivery group.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BaseCartLineConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryAddress", + "description": "The destination address for the delivery group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryOptions", + "description": "The delivery options available for the delivery group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDeliveryOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The ID for the delivery group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedDeliveryOption", + "description": "The selected delivery option for the delivery group.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CartDeliveryOption", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDeliveryGroupConnection", + "description": "An auto-generated type for paginating through multiple CartDeliveryGroups.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDeliveryGroupEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CartDeliveryGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDeliveryGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDeliveryGroupEdge", + "description": "An auto-generated type which holds one CartDeliveryGroup and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CartDeliveryGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartDeliveryGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDeliveryOption", + "description": "Information about a delivery option.", + "fields": [ + { + "name": "code", + "description": "The code of the delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryMethodType", + "description": "The method for the delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DeliveryMethodType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedCost", + "description": "The estimated cost for the delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique identifier of the delivery option.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the delivery option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartDirectPaymentMethodInput", + "description": "The input fields for submitting direct payment method information for checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "billingAddress", + "description": "The customer's billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sessionId", + "description": "The session ID for the direct payment method used to create the payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cardSource", + "description": "The source of the credit card payment.", + "type": { + "kind": "ENUM", + "name": "CartCardSource", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "description": "The discounts that have been applied to the cart line.", + "fields": [ + { + "name": "discountedAmount", + "description": "The discounted amount that has been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CartAutomaticDiscountAllocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartCodeDiscountAllocation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartCustomDiscountAllocation", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CartDiscountCode", + "description": "The discount codes applied to the cart.", + "fields": [ + { + "name": "applicable", + "description": "Whether the discount code is applicable to the cart's current contents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The code for the discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartDiscountCodesUpdatePayload", + "description": "Return type for `cartDiscountCodesUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CartErrorCode", + "description": "Possible error codes that can be returned by `CartUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_MERCHANDISE_LINE", + "description": "Merchandise line was not found in cart.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_DISCOUNT_CODE", + "description": "Missing discount code.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_NOTE", + "description": "Missing note.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DELIVERY_GROUP", + "description": "Delivery group was not found in cart.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_DELIVERY_OPTION", + "description": "Delivery option was not valid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PAYMENT", + "description": "The payment wasn't valid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PAYMENT_EMPTY_CART", + "description": "Cannot update payment on an empty cart", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_METHOD_NOT_SUPPORTED", + "description": "The payment method is not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_METAFIELDS", + "description": "The metafields were not valid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartEstimatedCost", + "description": "The estimated costs that the buyer will pay at checkout.\nThe estimated cost uses\n[`CartBuyerIdentity`](https://shopify.dev/api/storefront/reference/cart/cartbuyeridentity)\nto determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).\n", + "fields": [ + { + "name": "checkoutChargeAmount", + "description": "The estimated amount, before taxes and discounts, for the customer to pay at checkout. The checkout charge amount doesn't include any deferred payments that'll be paid at a later date. If the cart has no deferred payments, then the checkout charge amount is equivalent to`subtotal_amount`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalAmount", + "description": "The estimated amount, before taxes and discounts, for the customer to pay.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The estimated total amount for the customer to pay.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDutyAmount", + "description": "The estimated duty amount for the customer to pay at checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxAmount", + "description": "The estimated tax amount for the customer to pay at checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartFreePaymentMethodInput", + "description": "The input fields for submitting a billing address without a selected payment method.\n", + "fields": null, + "inputFields": [ + { + "name": "billingAddress", + "description": "The customer's billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartInput", + "description": "The input fields to create a cart.", + "fields": null, + "inputFields": [ + { + "name": "attributes", + "description": "An array of key-value pairs that contains additional information about the cart.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "discountCodes", + "description": "The case-insensitive discount codes that the customer added at checkout.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "lines", + "description": "A list of merchandise lines to add to the cart.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartLineInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "A note that's associated with the cart. For example, the note can be a personalized message to the buyer.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "buyerIdentity", + "description": "The customer associated with the cart. Used to determine [international pricing]\n(https://shopify.dev/custom-storefronts/internationalization/international-pricing).\nBuyer identity should match the customer's shipping address.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartBuyerIdentityInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metafields", + "description": "The metafields to associate with this cart.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartInputMetafieldInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartInputMetafieldInput", + "description": "The input fields for a cart metafield value to set.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key name of the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of data that the cart metafield stores.\nThe type of data must be a [supported type](https://shopify.dev/apps/metafields/types).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLine", + "description": "Represents information about the merchandise in the cart.", + "fields": [ + { + "name": "attribute", + "description": "An attribute associated with the cart line.", + "args": [ + { + "name": "key", + "description": "The key of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The attributes associated with the cart line. Attributes are represented as key-value pairs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cost", + "description": "The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineCost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedCost", + "description": "The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineEstimatedCost", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `cost` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchandise", + "description": "The merchandise that the buyer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "Merchandise", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the merchandise that the customer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanAllocation", + "description": "The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "BaseCartLine", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLineCost", + "description": "The cost of the merchandise line that the buyer will pay at checkout.", + "fields": [ + { + "name": "amountPerQuantity", + "description": "The amount of the merchandise line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtAmountPerQuantity", + "description": "The compare at amount of the merchandise line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalAmount", + "description": "The cost of the merchandise line before line-level discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The total cost of the merchandise line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLineEstimatedCost", + "description": "The estimated cost of the merchandise line that the buyer will pay at checkout.\n", + "fields": [ + { + "name": "amount", + "description": "The amount of the merchandise line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtAmount", + "description": "The compare at amount of the merchandise line.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalAmount", + "description": "The estimated cost of the merchandise line before discounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalAmount", + "description": "The estimated total cost of the merchandise line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartLineInput", + "description": "The input fields to create a merchandise line on a cart.", + "fields": null, + "inputFields": [ + { + "name": "attributes", + "description": "An array of key-value pairs that contains additional information about the merchandise line.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the merchandise.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "merchandiseId", + "description": "The ID of the merchandise that the buyer intends to purchase.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanId", + "description": "The ID of the selling plan that the merchandise is being purchased with.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartLineUpdateInput", + "description": "The input fields to update a line item on a cart.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the merchandise line.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "merchandiseId", + "description": "The ID of the merchandise for the line item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the line item.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "attributes", + "description": "An array of key-value pairs that contains additional information about the merchandise line.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sellingPlanId", + "description": "The ID of the selling plan that the merchandise is being purchased with.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLinesAddPayload", + "description": "Return type for `cartLinesAdd` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLinesRemovePayload", + "description": "Return type for `cartLinesRemove` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartLinesUpdatePayload", + "description": "Return type for `cartLinesUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartMetafieldDeleteInput", + "description": "The input fields to delete a cart metafield.", + "fields": null, + "inputFields": [ + { + "name": "ownerId", + "description": "The ID of the cart resource.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "key", + "description": "The key name of the cart metafield. Can either be a composite key (`namespace.key`) or a simple key\n that relies on the default app-reserved namespace.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartMetafieldDeletePayload", + "description": "Return type for `cartMetafieldDelete` mutation.", + "fields": [ + { + "name": "deletedId", + "description": "The ID of the deleted cart metafield.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldDeleteUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartMetafieldsSetInput", + "description": "The input fields for a cart metafield value to set.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key name of the cart metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "ownerId", + "description": "The ID of the cart resource.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of data that the cart metafield stores.\nThe type of data must be a [supported type](https://shopify.dev/apps/metafields/types).\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The data to store in the cart metafield. The data is always stored as a string, regardless of the metafield's type.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartMetafieldsSetPayload", + "description": "Return type for `cartMetafieldsSet` mutation.", + "fields": [ + { + "name": "metafields", + "description": "The list of cart metafields that were set.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartNoteUpdatePayload", + "description": "Return type for `cartNoteUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartPaymentInput", + "description": "The input fields for updating the payment method that will be used to checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "The amount that the customer will be charged at checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sourceIdentifier", + "description": "An ID of the order placed on the originating platform.\nNote that this value doesn't correspond to the Shopify Order ID.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "freePaymentMethod", + "description": "The input fields to use to checkout a cart without providing a payment method.\nUse this payment method input if the total cost of the cart is 0.\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartFreePaymentMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "directPaymentMethod", + "description": "The input fields to use when checking out a cart with a direct payment method (like a credit card).\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartDirectPaymentMethodInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "walletPaymentMethod", + "description": "The input fields to use when checking out a cart with a wallet payment method (like Shop Pay or Apple Pay).\n", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartWalletPaymentMethodInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartPaymentUpdatePayload", + "description": "Return type for `cartPaymentUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartSelectedDeliveryOptionInput", + "description": "The input fields for updating the selected delivery options for a delivery group.\n", + "fields": null, + "inputFields": [ + { + "name": "deliveryGroupId", + "description": "The ID of the cart delivery group.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "deliveryOptionHandle", + "description": "The handle of the selected delivery option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartSelectedDeliveryOptionsUpdatePayload", + "description": "Return type for `cartSelectedDeliveryOptionsUpdate` mutation.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CartSubmitForCompletionPayload", + "description": "Return type for `cartSubmitForCompletion` mutation.", + "fields": [ + { + "name": "result", + "description": "The result of cart submission for completion.", + "args": [], + "type": { + "kind": "UNION", + "name": "CartSubmitForCompletionResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "CartSubmitForCompletionResult", + "description": "The result of cart submit completion.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SubmitAlreadyAccepted", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubmitFailed", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubmitSuccess", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SubmitThrottled", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "CartUserError", + "description": "Represents an error that happens during execution of a cart mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CartErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CartWalletPaymentMethodInput", + "description": "The input fields for submitting wallet payment method information for checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "applePayWalletContent", + "description": "The payment method information for the Apple Pay wallet.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ApplePayWalletContentInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shopPayWalletContent", + "description": "The payment method information for the Shop Pay wallet.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ShopPayWalletContentInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Checkout", + "description": "A container for all the information required to checkout items and pay.", + "fields": [ + { + "name": "appliedGiftCards", + "description": "The gift cards used on the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AppliedGiftCard", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableShippingRates", + "description": "The available shipping rates for this Checkout.\nShould only be used when checkout `requiresShipping` is `true` and\nthe shipping address is valid.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AvailableShippingRates", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyerIdentity", + "description": "The identity of the customer associated with the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutBuyerIdentity", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completedAt", + "description": "The date and time when the checkout was completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the checkout was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The currency code for the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of extra information that's added to the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplications", + "description": "Discounts that have been applied on the checkout.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountApplicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email attached to this checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "A list of line item objects, each one containing information about an item in the checkout.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItemsSubtotalPrice", + "description": "The sum of all the prices of all the items in the checkout. Duties, taxes, shipping and discounts excluded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note associated with the checkout.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The resulting order from a paid checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderStatusUrl", + "description": "The Order Status Page for this Checkout, null when checkout isn't completed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentDue", + "description": "The amount left to be paid. This is equal to the cost of the line items, taxes, and shipping, minus discounts and gift cards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentDueV2", + "description": "The amount left to be paid. This is equal to the cost of the line items, duties, taxes, and shipping, minus discounts and gift cards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `paymentDue` instead." + }, + { + "name": "ready", + "description": "Whether or not the Checkout is ready and can be completed. Checkouts may\nhave asynchronous operations that can take time to finish. If you want\nto complete a checkout or ensure all the fields are populated and up to\ndate, polling is required until the value is true.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "States whether or not the fulfillment requires shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The shipping address to where the line items will be shipped.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDiscountAllocations", + "description": "The discounts that have been allocated onto the shipping line by discount applications.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingLine", + "description": "Once a shipping rate is selected by the customer it's transitioned to a `shipping_line` object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingRate", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPrice", + "description": "The price at checkout before shipping and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceV2", + "description": "The price at checkout before duties, shipping, and taxes.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `subtotalPrice` instead." + }, + { + "name": "taxExempt", + "description": "Whether the checkout is tax exempt.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "taxesIncluded", + "description": "Whether taxes are included in the line item and shipping line prices.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalDuties", + "description": "The sum of all the duties applied to the line items in the checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPrice", + "description": "The sum of all the prices of all the items in the checkout, including taxes and duties.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceV2", + "description": "The sum of all the prices of all the items in the checkout, including taxes and duties.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalPrice` instead." + }, + { + "name": "totalTax", + "description": "The sum of all the taxes applied to the line items and shipping lines in the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxV2", + "description": "The sum of all the taxes applied to the line items and shipping lines in the checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTax` instead." + }, + { + "name": "updatedAt", + "description": "The date and time when the checkout was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "webUrl", + "description": "The url pointing to the checkout accessible from the web.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutAttributesUpdateV2Input", + "description": "The input fields required to update a checkout's attributes.", + "fields": null, + "inputFields": [ + { + "name": "customAttributes", + "description": "A list of extra information that's added to the checkout.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The text of an optional note that a shop owner can attach to the checkout.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "allowPartialAddresses", + "description": "Allows setting partial addresses on a Checkout, skipping the full validation of attributes.\nThe required attributes are city, province, and country.\nFull validation of the addresses is still done at completion time. Defaults to `false` with \neach operation.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutAttributesUpdateV2Payload", + "description": "Return type for `checkoutAttributesUpdateV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutBuyerIdentity", + "description": "The identity of the customer associated with the checkout.", + "fields": [ + { + "name": "countryCode", + "description": "The country code for the checkout. For example, `CA`.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutBuyerIdentityInput", + "description": "The input fields for the identity of the customer associated with the checkout.", + "fields": null, + "inputFields": [ + { + "name": "countryCode", + "description": "The country code of one of the shop's\n[enabled countries](https://help.shopify.com/en/manual/payments/shopify-payments/multi-currency/setup).\nFor example, `CA`. Including this field creates a checkout in the specified country's currency.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCompleteFreePayload", + "description": "Return type for `checkoutCompleteFree` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCompleteWithCreditCardV2Payload", + "description": "Return type for `checkoutCompleteWithCreditCardV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The checkout on which the payment was applied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment", + "description": "A representation of the attempted payment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Payment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCompleteWithTokenizedPaymentV3Payload", + "description": "Return type for `checkoutCompleteWithTokenizedPaymentV3` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The checkout on which the payment was applied.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment", + "description": "A representation of the attempted payment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Payment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutCreateInput", + "description": "The input fields required to create a checkout.", + "fields": null, + "inputFields": [ + { + "name": "allowPartialAddresses", + "description": "Allows setting partial addresses on a Checkout, skipping the full validation of attributes.\nThe required attributes are city, province, and country.\nFull validation of addresses is still done at completion time. Defaults to `null`.\n", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "A list of extra information that's added to the checkout.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email with which the customer wants to checkout.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lineItems", + "description": "A list of line item objects, each one containing information about an item in the checkout.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The text of an optional note that a shop owner can attach to the checkout.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "buyerIdentity", + "description": "The identity of the customer associated with the checkout.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CheckoutBuyerIdentityInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingAddress", + "description": "The shipping address to where the line items will be shipped.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCreatePayload", + "description": "Return type for `checkoutCreate` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The new checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queueToken", + "description": "The checkout queue token. Available only to selected stores.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCustomerAssociateV2Payload", + "description": "Return type for `checkoutCustomerAssociateV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The associated customer object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCustomerDisassociateV2Payload", + "description": "Return type for `checkoutCustomerDisassociateV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutDiscountCodeApplyV2Payload", + "description": "Return type for `checkoutDiscountCodeApplyV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutDiscountCodeRemovePayload", + "description": "Return type for `checkoutDiscountCodeRemove` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutEmailUpdateV2Payload", + "description": "Return type for `checkoutEmailUpdateV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The checkout object with the updated email.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CheckoutErrorCode", + "description": "Possible error codes that can be returned by `CheckoutUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN", + "description": "The input value should be less than the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GREATER_THAN_OR_EQUAL_TO", + "description": "The input value should be greater than or equal to the minimum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_COMPLETED", + "description": "Checkout is already completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCKED", + "description": "Checkout is locked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_SUPPORTED", + "description": "Input value is not supported.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAD_DOMAIN", + "description": "Input email contains an invalid domain name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_FOR_COUNTRY", + "description": "Input Zip is invalid for country provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_FOR_COUNTRY_AND_PROVINCE", + "description": "Input Zip is invalid for country and province provided.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_STATE_IN_COUNTRY", + "description": "Invalid state in country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_PROVINCE_IN_COUNTRY", + "description": "Invalid province in country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_REGION_IN_COUNTRY", + "description": "Invalid region in country.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_RATE_EXPIRED", + "description": "Shipping rate expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_UNUSABLE", + "description": "Gift card cannot be applied to a checkout that contains a gift card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_DISABLED", + "description": "Gift card is disabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_CODE_INVALID", + "description": "Gift card code is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_ALREADY_APPLIED", + "description": "Gift card has already been applied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_CURRENCY_MISMATCH", + "description": "Gift card currency does not match checkout currency.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_EXPIRED", + "description": "Gift card is expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_DEPLETED", + "description": "Gift card has no funds left.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIFT_CARD_NOT_FOUND", + "description": "Gift card was not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CART_DOES_NOT_MEET_DISCOUNT_REQUIREMENTS_NOTICE", + "description": "Cart does not meet discount requirements notice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_EXPIRED", + "description": "Discount expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_DISABLED", + "description": "Discount disabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_LIMIT_REACHED", + "description": "Discount limit reached.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIGHER_VALUE_DISCOUNT_APPLIED", + "description": "Higher value discount applied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAXIMUM_DISCOUNT_CODE_LIMIT_REACHED", + "description": "Maximum number of discount codes limit reached.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_NOT_FOUND", + "description": "Discount not found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_ALREADY_USED_ONCE_PER_CUSTOMER_DISCOUNT_NOTICE", + "description": "Customer already used once per customer discount notice.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_CODE_APPLICATION_FAILED", + "description": "Discount code isn't working right now. Please contact us for help.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMPTY", + "description": "Checkout is already completed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_ENOUGH_IN_STOCK", + "description": "Not enough in stock.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MISSING_PAYMENT_INPUT", + "description": "Missing payment input.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_PRICE_MISMATCH", + "description": "The amount of the payment does not match the value to be paid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LINE_ITEM_NOT_FOUND", + "description": "Line item was not found in checkout.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNABLE_TO_APPLY", + "description": "Unable to apply discount.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT_ALREADY_APPLIED", + "description": "Discount already applied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THROTTLED_DURING_CHECKOUT", + "description": "Throttled during checkout.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPIRED_QUEUE_TOKEN", + "description": "Queue token has expired.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_QUEUE_TOKEN", + "description": "Queue token is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_COUNTRY_AND_CURRENCY", + "description": "Cannot specify country and presentment currency code.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_NOT_AVAILABLE", + "description": "Product is not published for this customer.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutGiftCardRemoveV2Payload", + "description": "Return type for `checkoutGiftCardRemoveV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutGiftCardsAppendPayload", + "description": "Return type for `checkoutGiftCardsAppend` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItem", + "description": "A single line item in the checkout, grouped by variant and attributes.", + "fields": [ + { + "name": "customAttributes", + "description": "Extra information in the form of an array of Key-Value pairs about the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated onto the checkout line item by discount applications.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Title of the line item. Defaults to the product's title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitPrice", + "description": "Unit price of the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "Product variant of the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemConnection", + "description": "An auto-generated type for paginating through multiple CheckoutLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CheckoutLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemEdge", + "description": "An auto-generated type which holds one CheckoutLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CheckoutLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemInput", + "description": "The input fields to create a line item on a checkout.", + "fields": null, + "inputFields": [ + { + "name": "customAttributes", + "description": "Extra information in the form of an array of Key-Value pairs about the line item.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "variantId", + "description": "The ID of the product variant for the line item.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemUpdateInput", + "description": "The input fields to update a line item on the checkout.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The ID of the line item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customAttributes", + "description": "Extra information in the form of an array of Key-Value pairs about the line item.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The quantity of the line item.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "variantId", + "description": "The variant ID of the line item.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemsAddPayload", + "description": "Return type for `checkoutLineItemsAdd` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemsRemovePayload", + "description": "Return type for `checkoutLineItemsRemove` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemsReplacePayload", + "description": "Return type for `checkoutLineItemsReplace` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItemsUpdatePayload", + "description": "Return type for `checkoutLineItemsUpdate` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutShippingAddressUpdateV2Payload", + "description": "Return type for `checkoutShippingAddressUpdateV2` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutShippingLineUpdatePayload", + "description": "Return type for `checkoutShippingLineUpdate` mutation.", + "fields": [ + { + "name": "checkout", + "description": "The updated checkout object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `checkoutUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutUserError", + "description": "Represents an error that happens during execution of a checkout mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CheckoutErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "description": "A collection represents a grouping of products that a shop owner can create to\norganize them or make their shops easier to browse.\n", + "fields": [ + { + "name": "description", + "description": "Stripped description of the collection, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "descriptionHtml", + "description": "The description of the collection, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A human-friendly unique string for the collection automatically generated from its title.\nLimit of 255 characters.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "Image associated with the collection.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "List of products in the collection.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductCollectionSortKeys", + "ofType": null + }, + "defaultValue": "COLLECTION_DEFAULT" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "filters", + "description": "Returns a subset of products matching all product filters.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilter", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "The collection's SEO information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The collection’s name. Limit of 255 characters.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the collection was last modified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Trackable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionConnection", + "description": "An auto-generated type for paginating through multiple Collections.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CollectionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total count of Collections.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CollectionEdge", + "description": "An auto-generated type which holds one Collection and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CollectionEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CollectionSortKeys", + "description": "The set of valid sort keys for the Collection query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Color", + "description": "A string containing a hexadecimal representation of a color.\n\nFor example, \"#6A8D48\".\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Comment", + "description": "A comment on an article.", + "fields": [ + { + "name": "author", + "description": "The comment’s author.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CommentAuthor", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "content", + "description": "Stripped content of the comment, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contentHtml", + "description": "The content of the comment, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CommentAuthor", + "description": "The author of a comment.", + "fields": [ + { + "name": "email", + "description": "The author's email.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The author’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CommentConnection", + "description": "An auto-generated type for paginating through multiple Comments.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CommentEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in CommentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Comment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CommentEdge", + "description": "An auto-generated type which holds one Comment and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of CommentEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Comment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompletePaymentChallenge", + "description": "The action for the 3DS payment redirect.", + "fields": [ + { + "name": "redirectUrl", + "description": "The URL for the 3DS payment redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CompletionError", + "description": "An error that occurred during a cart completion attempt.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CompletionErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CompletionErrorCode", + "description": "The code of the error that occurred during a cart completion attempt.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY_RESERVATION_ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_TRANSIENT_ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_AMOUNT_TOO_SMALL", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_GATEWAY_NOT_ENABLED_ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_INSUFFICIENT_FUNDS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_INVALID_PAYMENT_METHOD", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_INVALID_CURRENCY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_INVALID_CREDIT_CARD", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_INVALID_BILLING_ADDRESS", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_CARD_DECLINED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENT_CALL_ISSUER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ComponentizableCartLine", + "description": "Represents information about the grouped merchandise in the cart.", + "fields": [ + { + "name": "attribute", + "description": "An attribute associated with the cart line.", + "args": [ + { + "name": "key", + "description": "The key of the attribute.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The attributes associated with the cart line. Attributes are represented as key-value pairs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cost", + "description": "The cost of the merchandise that the buyer will pay for at checkout. The costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineCost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been applied to the cart line.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "CartDiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "estimatedCost", + "description": "The estimated cost of the merchandise that the buyer will pay for at checkout. The estimated costs are subject to change and changes will be reflected at checkout.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLineEstimatedCost", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `cost` instead." + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineComponents", + "description": "The components of the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CartLine", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "merchandise", + "description": "The merchandise that the buyer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "Merchandise", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the merchandise that the customer intends to purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanAllocation", + "description": "The selling plan associated with the cart line and the effect that each selling plan has on variants when they're purchased.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "BaseCartLine", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Country", + "description": "A country.", + "fields": [ + { + "name": "availableLanguages", + "description": "The languages available for the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Language", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currency", + "description": "The currency of the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Currency", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isoCode", + "description": "The ISO code of the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market that includes this country.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitSystem", + "description": "The unit system used in the country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "UnitSystem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CountryCode", + "description": "The code designating a country/region, which generally follows ISO 3166-1 alpha-2 guidelines.\nIf a territory doesn't have a country code value in the `CountryCode` enum, then it might be considered a subdivision\nof another country. For example, the territories associated with Spain are represented by the country code `ES`,\nand the territories associated with the United States of America are represented by the country code `US`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AF", + "description": "Afghanistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AX", + "description": "Åland Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AL", + "description": "Albania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZ", + "description": "Algeria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AD", + "description": "Andorra.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AO", + "description": "Angola.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AI", + "description": "Anguilla.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AG", + "description": "Antigua & Barbuda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AR", + "description": "Argentina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AM", + "description": "Armenia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AW", + "description": "Aruba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AC", + "description": "Ascension Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AU", + "description": "Australia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AT", + "description": "Austria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZ", + "description": "Azerbaijan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BS", + "description": "Bahamas.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BH", + "description": "Bahrain.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BD", + "description": "Bangladesh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BB", + "description": "Barbados.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BY", + "description": "Belarus.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BE", + "description": "Belgium.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZ", + "description": "Belize.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BJ", + "description": "Benin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BM", + "description": "Bermuda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BT", + "description": "Bhutan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BO", + "description": "Bolivia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BA", + "description": "Bosnia & Herzegovina.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BW", + "description": "Botswana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BV", + "description": "Bouvet Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BR", + "description": "Brazil.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IO", + "description": "British Indian Ocean Territory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BN", + "description": "Brunei.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BG", + "description": "Bulgaria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BF", + "description": "Burkina Faso.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BI", + "description": "Burundi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KH", + "description": "Cambodia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA", + "description": "Canada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CV", + "description": "Cape Verde.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BQ", + "description": "Caribbean Netherlands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KY", + "description": "Cayman Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CF", + "description": "Central African Republic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TD", + "description": "Chad.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CL", + "description": "Chile.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CN", + "description": "China.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CX", + "description": "Christmas Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CC", + "description": "Cocos (Keeling) Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CO", + "description": "Colombia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KM", + "description": "Comoros.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CG", + "description": "Congo - Brazzaville.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CD", + "description": "Congo - Kinshasa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CK", + "description": "Cook Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CR", + "description": "Costa Rica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HR", + "description": "Croatia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CU", + "description": "Cuba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CW", + "description": "Curaçao.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CY", + "description": "Cyprus.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZ", + "description": "Czechia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CI", + "description": "Côte d’Ivoire.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DK", + "description": "Denmark.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DJ", + "description": "Djibouti.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DM", + "description": "Dominica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DO", + "description": "Dominican Republic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EC", + "description": "Ecuador.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EG", + "description": "Egypt.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SV", + "description": "El Salvador.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GQ", + "description": "Equatorial Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ER", + "description": "Eritrea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EE", + "description": "Estonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZ", + "description": "Eswatini.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ET", + "description": "Ethiopia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FK", + "description": "Falkland Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FO", + "description": "Faroe Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJ", + "description": "Fiji.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FI", + "description": "Finland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FR", + "description": "France.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GF", + "description": "French Guiana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PF", + "description": "French Polynesia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TF", + "description": "French Southern Territories.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GA", + "description": "Gabon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GM", + "description": "Gambia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GE", + "description": "Georgia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DE", + "description": "Germany.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GH", + "description": "Ghana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GI", + "description": "Gibraltar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GR", + "description": "Greece.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GL", + "description": "Greenland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GD", + "description": "Grenada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GP", + "description": "Guadeloupe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GT", + "description": "Guatemala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GG", + "description": "Guernsey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GN", + "description": "Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GW", + "description": "Guinea-Bissau.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GY", + "description": "Guyana.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HT", + "description": "Haiti.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HM", + "description": "Heard & McDonald Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VA", + "description": "Vatican City.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HN", + "description": "Honduras.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HK", + "description": "Hong Kong SAR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HU", + "description": "Hungary.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": "Iceland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN", + "description": "India.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Indonesia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IR", + "description": "Iran.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQ", + "description": "Iraq.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IE", + "description": "Ireland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IM", + "description": "Isle of Man.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IL", + "description": "Israel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IT", + "description": "Italy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JM", + "description": "Jamaica.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JP", + "description": "Japan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JE", + "description": "Jersey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JO", + "description": "Jordan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZ", + "description": "Kazakhstan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KE", + "description": "Kenya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KI", + "description": "Kiribati.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KP", + "description": "North Korea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XK", + "description": "Kosovo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KW", + "description": "Kuwait.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KG", + "description": "Kyrgyzstan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LA", + "description": "Laos.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LV", + "description": "Latvia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LB", + "description": "Lebanon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LS", + "description": "Lesotho.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LR", + "description": "Liberia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LY", + "description": "Libya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LI", + "description": "Liechtenstein.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LT", + "description": "Lithuania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LU", + "description": "Luxembourg.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MO", + "description": "Macao SAR.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "Madagascar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MW", + "description": "Malawi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MY", + "description": "Malaysia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MV", + "description": "Maldives.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ML", + "description": "Mali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MT", + "description": "Malta.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MQ", + "description": "Martinique.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MR", + "description": "Mauritania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MU", + "description": "Mauritius.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YT", + "description": "Mayotte.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MX", + "description": "Mexico.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MD", + "description": "Moldova.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MC", + "description": "Monaco.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MN", + "description": "Mongolia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ME", + "description": "Montenegro.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MS", + "description": "Montserrat.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MA", + "description": "Morocco.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZ", + "description": "Mozambique.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MM", + "description": "Myanmar (Burma).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NA", + "description": "Namibia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NR", + "description": "Nauru.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NP", + "description": "Nepal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NL", + "description": "Netherlands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AN", + "description": "Netherlands Antilles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NC", + "description": "New Caledonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZ", + "description": "New Zealand.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NI", + "description": "Nicaragua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NE", + "description": "Niger.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NG", + "description": "Nigeria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NU", + "description": "Niue.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NF", + "description": "Norfolk Island.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MK", + "description": "North Macedonia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO", + "description": "Norway.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OM", + "description": "Oman.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PK", + "description": "Pakistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PS", + "description": "Palestinian Territories.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PA", + "description": "Panama.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PG", + "description": "Papua New Guinea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PY", + "description": "Paraguay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PE", + "description": "Peru.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PH", + "description": "Philippines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PN", + "description": "Pitcairn Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PL", + "description": "Poland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT", + "description": "Portugal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QA", + "description": "Qatar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CM", + "description": "Cameroon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RE", + "description": "Réunion.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RO", + "description": "Romania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RU", + "description": "Russia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RW", + "description": "Rwanda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BL", + "description": "St. Barthélemy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SH", + "description": "St. Helena.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KN", + "description": "St. Kitts & Nevis.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LC", + "description": "St. Lucia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MF", + "description": "St. Martin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PM", + "description": "St. Pierre & Miquelon.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WS", + "description": "Samoa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SM", + "description": "San Marino.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ST", + "description": "São Tomé & Príncipe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SA", + "description": "Saudi Arabia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SN", + "description": "Senegal.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RS", + "description": "Serbia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SC", + "description": "Seychelles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SL", + "description": "Sierra Leone.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SG", + "description": "Singapore.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SX", + "description": "Sint Maarten.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SK", + "description": "Slovakia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SI", + "description": "Slovenia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SB", + "description": "Solomon Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SO", + "description": "Somalia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZA", + "description": "South Africa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GS", + "description": "South Georgia & South Sandwich Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KR", + "description": "South Korea.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SS", + "description": "South Sudan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ES", + "description": "Spain.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LK", + "description": "Sri Lanka.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VC", + "description": "St. Vincent & Grenadines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SD", + "description": "Sudan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SR", + "description": "Suriname.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SJ", + "description": "Svalbard & Jan Mayen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SE", + "description": "Sweden.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CH", + "description": "Switzerland.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SY", + "description": "Syria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TW", + "description": "Taiwan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJ", + "description": "Tajikistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZ", + "description": "Tanzania.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TH", + "description": "Thailand.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TL", + "description": "Timor-Leste.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TG", + "description": "Togo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TK", + "description": "Tokelau.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TO", + "description": "Tonga.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TT", + "description": "Trinidad & Tobago.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TA", + "description": "Tristan da Cunha.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TN", + "description": "Tunisia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TR", + "description": "Turkey.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TM", + "description": "Turkmenistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TC", + "description": "Turks & Caicos Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TV", + "description": "Tuvalu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UG", + "description": "Uganda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UA", + "description": "Ukraine.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AE", + "description": "United Arab Emirates.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GB", + "description": "United Kingdom.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "US", + "description": "United States.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UM", + "description": "U.S. Outlying Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UY", + "description": "Uruguay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZ", + "description": "Uzbekistan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VU", + "description": "Vanuatu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VE", + "description": "Venezuela.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VN", + "description": "Vietnam.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VG", + "description": "British Virgin Islands.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WF", + "description": "Wallis & Futuna.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EH", + "description": "Western Sahara.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YE", + "description": "Yemen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZM", + "description": "Zambia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZW", + "description": "Zimbabwe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZZ", + "description": "Unknown Region.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CreditCard", + "description": "Credit card information used for a payment.", + "fields": [ + { + "name": "brand", + "description": "The brand of the credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryMonth", + "description": "The expiry month of the credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiryYear", + "description": "The expiry year of the credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstDigits", + "description": "The credit card's BIN number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of the card holder.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastDigits", + "description": "The last 4 digits of the credit card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of the card holder.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maskedNumber", + "description": "The masked credit card number with only the last 4 digits displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreditCardPaymentInputV2", + "description": "Specifies the fields required to complete a checkout with\na Shopify vaulted credit card payment.\n", + "fields": null, + "inputFields": [ + { + "name": "billingAddress", + "description": "The billing address for the payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "idempotencyKey", + "description": "A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentAmount", + "description": "The amount and currency of the payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "test", + "description": "Executes the payment in test mode if possible. Defaults to `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "vaultId", + "description": "The ID returned by Shopify's Card Vault.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CropRegion", + "description": "The part of the image that should remain after cropping.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CENTER", + "description": "Keep the center of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOP", + "description": "Keep the top of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTTOM", + "description": "Keep the bottom of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LEFT", + "description": "Keep the left of the image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RIGHT", + "description": "Keep the right of the image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Currency", + "description": "A currency.", + "fields": [ + { + "name": "isoCode", + "description": "The ISO code of the currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "symbol", + "description": "The symbol of the currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CurrencyCode", + "description": "The three-letter currency codes that represent the world currencies used in\nstores. These include standard ISO 4217 codes, legacy codes,\nand non-standard codes.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "USD", + "description": "United States Dollars (USD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EUR", + "description": "Euro (EUR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GBP", + "description": "United Kingdom Pounds (GBP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAD", + "description": "Canadian Dollars (CAD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AFN", + "description": "Afghan Afghani (AFN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALL", + "description": "Albanian Lek (ALL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZD", + "description": "Algerian Dinar (DZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AOA", + "description": "Angolan Kwanza (AOA).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARS", + "description": "Argentine Pesos (ARS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMD", + "description": "Armenian Dram (AMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWG", + "description": "Aruban Florin (AWG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUD", + "description": "Australian Dollars (AUD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BBD", + "description": "Barbadian Dollar (BBD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZN", + "description": "Azerbaijani Manat (AZN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BDT", + "description": "Bangladesh Taka (BDT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BSD", + "description": "Bahamian Dollar (BSD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BHD", + "description": "Bahraini Dinar (BHD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BIF", + "description": "Burundian Franc (BIF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BZD", + "description": "Belize Dollar (BZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BMD", + "description": "Bermudian Dollar (BMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BTN", + "description": "Bhutanese Ngultrum (BTN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAM", + "description": "Bosnia and Herzegovina Convertible Mark (BAM).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRL", + "description": "Brazilian Real (BRL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOB", + "description": "Bolivian Boliviano (BOB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BWP", + "description": "Botswana Pula (BWP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BND", + "description": "Brunei Dollar (BND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BGN", + "description": "Bulgarian Lev (BGN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MMK", + "description": "Burmese Kyat (MMK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KHR", + "description": "Cambodian Riel.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CVE", + "description": "Cape Verdean escudo (CVE).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KYD", + "description": "Cayman Dollars (KYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XAF", + "description": "Central African CFA Franc (XAF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLP", + "description": "Chilean Peso (CLP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CNY", + "description": "Chinese Yuan Renminbi (CNY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COP", + "description": "Colombian Peso (COP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KMF", + "description": "Comorian Franc (KMF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CDF", + "description": "Congolese franc (CDF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CRC", + "description": "Costa Rican Colones (CRC).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HRK", + "description": "Croatian Kuna (HRK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CZK", + "description": "Czech Koruny (CZK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DKK", + "description": "Danish Kroner (DKK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOP", + "description": "Dominican Peso (DOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XCD", + "description": "East Caribbean Dollar (XCD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EGP", + "description": "Egyptian Pound (EGP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ETB", + "description": "Ethiopian Birr (ETB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XPF", + "description": "CFP Franc (XPF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FJD", + "description": "Fijian Dollars (FJD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GMD", + "description": "Gambian Dalasi (GMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GHS", + "description": "Ghanaian Cedi (GHS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GTQ", + "description": "Guatemalan Quetzal (GTQ).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GYD", + "description": "Guyanese Dollar (GYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GEL", + "description": "Georgian Lari (GEL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HTG", + "description": "Haitian Gourde (HTG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HNL", + "description": "Honduran Lempira (HNL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HKD", + "description": "Hong Kong Dollars (HKD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HUF", + "description": "Hungarian Forint (HUF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ISK", + "description": "Icelandic Kronur (ISK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INR", + "description": "Indian Rupees (INR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IDR", + "description": "Indonesian Rupiah (IDR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ILS", + "description": "Israeli New Shekel (NIS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IQD", + "description": "Iraqi Dinar (IQD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JMD", + "description": "Jamaican Dollars (JMD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JPY", + "description": "Japanese Yen (JPY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JEP", + "description": "Jersey Pound.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JOD", + "description": "Jordanian Dinar (JOD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KZT", + "description": "Kazakhstani Tenge (KZT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KES", + "description": "Kenyan Shilling (KES).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KWD", + "description": "Kuwaiti Dinar (KWD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KGS", + "description": "Kyrgyzstani Som (KGS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAK", + "description": "Laotian Kip (LAK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LVL", + "description": "Latvian Lati (LVL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LBP", + "description": "Lebanese Pounds (LBP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LSL", + "description": "Lesotho Loti (LSL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LRD", + "description": "Liberian Dollar (LRD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LTL", + "description": "Lithuanian Litai (LTL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MGA", + "description": "Malagasy Ariary (MGA).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MKD", + "description": "Macedonia Denar (MKD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MOP", + "description": "Macanese Pataca (MOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MWK", + "description": "Malawian Kwacha (MWK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MVR", + "description": "Maldivian Rufiyaa (MVR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MXN", + "description": "Mexican Pesos (MXN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MYR", + "description": "Malaysian Ringgits (MYR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUR", + "description": "Mauritian Rupee (MUR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MDL", + "description": "Moldovan Leu (MDL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAD", + "description": "Moroccan Dirham.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MNT", + "description": "Mongolian Tugrik.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MZN", + "description": "Mozambican Metical.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAD", + "description": "Namibian Dollar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NPR", + "description": "Nepalese Rupee (NPR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ANG", + "description": "Netherlands Antillean Guilder.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NZD", + "description": "New Zealand Dollars (NZD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NIO", + "description": "Nicaraguan Córdoba (NIO).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NGN", + "description": "Nigerian Naira (NGN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOK", + "description": "Norwegian Kroner (NOK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OMR", + "description": "Omani Rial (OMR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAB", + "description": "Panamian Balboa (PAB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PKR", + "description": "Pakistani Rupee (PKR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PGK", + "description": "Papua New Guinean Kina (PGK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PYG", + "description": "Paraguayan Guarani (PYG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PEN", + "description": "Peruvian Nuevo Sol (PEN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PHP", + "description": "Philippine Peso (PHP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PLN", + "description": "Polish Zlotych (PLN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QAR", + "description": "Qatari Rial (QAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RON", + "description": "Romanian Lei (RON).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RUB", + "description": "Russian Rubles (RUB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RWF", + "description": "Rwandan Franc (RWF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WST", + "description": "Samoan Tala (WST).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SAR", + "description": "Saudi Riyal (SAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RSD", + "description": "Serbian dinar (RSD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCR", + "description": "Seychellois Rupee (SCR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SGD", + "description": "Singapore Dollars (SGD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SDG", + "description": "Sudanese Pound (SDG).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SYP", + "description": "Syrian Pound (SYP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZAR", + "description": "South African Rand (ZAR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KRW", + "description": "South Korean Won (KRW).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SSP", + "description": "South Sudanese Pound (SSP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SBD", + "description": "Solomon Islands Dollar (SBD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LKR", + "description": "Sri Lankan Rupees (LKR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SRD", + "description": "Surinamese Dollar (SRD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SZL", + "description": "Swazi Lilangeni (SZL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEK", + "description": "Swedish Kronor (SEK).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHF", + "description": "Swiss Francs (CHF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TWD", + "description": "Taiwan Dollars (TWD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "THB", + "description": "Thai baht (THB).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TZS", + "description": "Tanzanian Shilling (TZS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TTD", + "description": "Trinidad and Tobago Dollars (TTD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TND", + "description": "Tunisian Dinar (TND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TRY", + "description": "Turkish Lira (TRY).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TMT", + "description": "Turkmenistani Manat (TMT).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UGX", + "description": "Ugandan Shilling (UGX).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UAH", + "description": "Ukrainian Hryvnia (UAH).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AED", + "description": "United Arab Emirates Dirham (AED).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UYU", + "description": "Uruguayan Pesos (UYU).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZS", + "description": "Uzbekistan som (UZS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VUV", + "description": "Vanuatu Vatu (VUV).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VND", + "description": "Vietnamese đồng (VND).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XOF", + "description": "West African CFA franc (XOF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YER", + "description": "Yemeni Rial (YER).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZMW", + "description": "Zambian Kwacha (ZMW).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BYN", + "description": "Belarusian Ruble (BYN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BYR", + "description": "Belarusian Ruble (BYR).", + "isDeprecated": true, + "deprecationReason": "`BYR` is deprecated. Use `BYN` available from version `2021-01` onwards instead." + }, + { + "name": "DJF", + "description": "Djiboutian Franc (DJF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERN", + "description": "Eritrean Nakfa (ERN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FKP", + "description": "Falkland Islands Pounds (FKP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GIP", + "description": "Gibraltar Pounds (GIP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GNF", + "description": "Guinean Franc (GNF).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IRR", + "description": "Iranian Rial (IRR).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KID", + "description": "Kiribati Dollar (KID).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LYD", + "description": "Libyan Dinar (LYD).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MRU", + "description": "Mauritanian Ouguiya (MRU).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SLL", + "description": "Sierra Leonean Leone (SLL).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHP", + "description": "Saint Helena Pounds (SHP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SOS", + "description": "Somali Shilling (SOS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STD", + "description": "Sao Tome And Principe Dobra (STD).", + "isDeprecated": true, + "deprecationReason": "`STD` is deprecated. Use `STN` available from version `2022-07` onwards instead." + }, + { + "name": "STN", + "description": "Sao Tome And Principe Dobra (STN).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TJS", + "description": "Tajikistani Somoni (TJS).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOP", + "description": "Tongan Pa'anga (TOP).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VED", + "description": "Venezuelan Bolivares (VED).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VEF", + "description": "Venezuelan Bolivares (VEF).", + "isDeprecated": true, + "deprecationReason": "`VEF` is deprecated. Use `VES` available from version `2020-10` onwards instead." + }, + { + "name": "VES", + "description": "Venezuelan Bolivares (VES).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XXX", + "description": "Unrecognized currency.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "description": "A customer represents a customer account with the shop. Customer accounts store contact information for the customer, saving logged-in customers the trouble of having to provide it at every checkout.", + "fields": [ + { + "name": "acceptsMarketing", + "description": "Indicates whether the customer has consented to be sent marketing material via email.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addresses", + "description": "A list of addresses for the customer.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddressConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the customer was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "defaultAddress", + "description": "The customer’s default address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The customer’s name, email or phone number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The customer’s email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The customer’s first name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A unique ID for the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastIncompleteCheckout", + "description": "The customer's most recently updated, incomplete checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The customer’s last name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfOrders", + "description": "The number of orders that the customer has made at the store in their lifetime.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The orders associated with the customer.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "OrderSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `processed_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The customer’s phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A comma separated list of tags that have been added to the customer.\nAdditional access scope required: unauthenticated_read_customer_tags.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the customer information was updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "description": "A CustomerAccessToken represents the unique token required to make modifications to the customer object.", + "fields": [ + { + "name": "accessToken", + "description": "The customer’s access token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expiresAt", + "description": "The date and time when the customer access token expires.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerAccessTokenCreateInput", + "description": "The input fields required to create a customer access token.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The email associated to the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The login password to be used by the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessTokenCreatePayload", + "description": "Return type for `customerAccessTokenCreate` mutation.", + "fields": [ + { + "name": "customerAccessToken", + "description": "The newly created customer access token object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessTokenCreateWithMultipassPayload", + "description": "Return type for `customerAccessTokenCreateWithMultipass` mutation.", + "fields": [ + { + "name": "customerAccessToken", + "description": "An access token object associated with the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessTokenDeletePayload", + "description": "Return type for `customerAccessTokenDelete` mutation.", + "fields": [ + { + "name": "deletedAccessToken", + "description": "The destroyed access token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletedCustomerAccessTokenId", + "description": "ID of the destroyed customer access token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessTokenRenewPayload", + "description": "Return type for `customerAccessTokenRenew` mutation.", + "fields": [ + { + "name": "customerAccessToken", + "description": "The renewed customer access token object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerActivateByUrlPayload", + "description": "Return type for `customerActivateByUrl` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer that was activated.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessToken", + "description": "A new customer access token for the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerActivateInput", + "description": "The input fields to activate a customer.", + "fields": null, + "inputFields": [ + { + "name": "activationToken", + "description": "The activation token required to activate the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "New password that will be set during activation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerActivatePayload", + "description": "Return type for `customerActivate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessToken", + "description": "A newly created customer access token object for the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressCreatePayload", + "description": "Return type for `customerAddressCreate` mutation.", + "fields": [ + { + "name": "customerAddress", + "description": "The new customer address object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressDeletePayload", + "description": "Return type for `customerAddressDelete` mutation.", + "fields": [ + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deletedCustomerAddressId", + "description": "ID of the deleted customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressUpdatePayload", + "description": "Return type for `customerAddressUpdate` mutation.", + "fields": [ + { + "name": "customerAddress", + "description": "The customer’s updated mailing address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "description": "The input fields to create a new customer.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The customer’s email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "firstName", + "description": "The customer’s first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The customer’s last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "acceptsMarketing", + "description": "Indicates whether the customer has consented to be sent marketing material via email.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The login password used by the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerCreatePayload", + "description": "Return type for `customerCreate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The created customer object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerDefaultAddressUpdatePayload", + "description": "Return type for `customerDefaultAddressUpdate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerErrorCode", + "description": "Possible error codes that can be returned by `CustomerUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID", + "description": "The input value is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAKEN", + "description": "The input value is already taken.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNIDENTIFIED_CUSTOMER", + "description": "Unidentified customer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CUSTOMER_DISABLED", + "description": "Customer is disabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PASSWORD_STARTS_OR_ENDS_WITH_WHITESPACE", + "description": "Input password starts or ends with whitespace.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTAINS_HTML_TAGS", + "description": "Input contains HTML tags.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CONTAINS_URL", + "description": "Input contains URL.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOKEN_INVALID", + "description": "Invalid activation token.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ALREADY_ENABLED", + "description": "Customer already enabled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": "Address does not exist.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BAD_DOMAIN", + "description": "Input email contains an invalid domain name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_MULTIPASS_REQUEST", + "description": "Multipass token is not valid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerRecoverPayload", + "description": "Return type for `customerRecover` mutation.", + "fields": [ + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerResetByUrlPayload", + "description": "Return type for `customerResetByUrl` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer object which was reset.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessToken", + "description": "A newly created customer access token object for the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerResetInput", + "description": "The input fields to reset a customer's password.", + "fields": null, + "inputFields": [ + { + "name": "password", + "description": "New password that will be set as part of the reset password process.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "resetToken", + "description": "The reset token required to reset the customer’s password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerResetPayload", + "description": "Return type for `customerReset` mutation.", + "fields": [ + { + "name": "customer", + "description": "The customer object which was reset.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessToken", + "description": "A newly created customer access token object for the customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "description": "The input fields to update the Customer information.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The customer’s email.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstName", + "description": "The customer’s first name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The customer’s last name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The login password used by the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_. To remove the phone number, specify `null`.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "acceptsMarketing", + "description": "Indicates whether the customer has consented to be sent marketing material via email.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerUpdatePayload", + "description": "Return type for `customerUpdate` mutation.", + "fields": [ + { + "name": "customer", + "description": "The updated customer object.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessToken", + "description": "The newly created customer access token. If the customer's password is updated, all previous access tokens\n(including the one used to perform this mutation) become invalid, and a new token is generated.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUserErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "userErrors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + } + } + }, + "isDeprecated": true, + "deprecationReason": "Use `customerUserErrors` instead." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerUserError", + "description": "Represents an error that happens during execution of a customer mutation.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "CustomerErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "DateTime", + "description": "Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.\nFor example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is\nrepresented as `\"2019-09-07T15:50:00Z`\".\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Decimal", + "description": "A signed decimal number, which supports arbitrary precision and is serialized as a string.\n\nExample values: `\"29.99\"`, `\"29.999\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "DeliveryAddress", + "description": "A delivery address of the buyer that is interacting with the cart.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryAddressInput", + "description": "The input fields for delivery address preferences.\n", + "fields": null, + "inputFields": [ + { + "name": "deliveryAddress", + "description": "A delivery address preference of a buyer that is interacting with the cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerAddressId", + "description": "The ID of a customer address that is associated with the buyer that is interacting with the cart.\n", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DeliveryMethodType", + "description": "List of different delivery method types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHIPPING", + "description": "Shipping.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICK_UP", + "description": "Local Pickup.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETAIL", + "description": "Retail.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOCAL", + "description": "Local Delivery.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICKUP_POINT", + "description": "Shipping to a Pickup Point.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NONE", + "description": "None.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DigitalWallet", + "description": "Digital wallet, such as Apple Pay, which can be used for accelerated checkouts.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLE_PAY", + "description": "Apple Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ANDROID_PAY", + "description": "Android Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GOOGLE_PAY", + "description": "Google Pay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOPIFY_PAY", + "description": "Shopify Pay.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountAllocation", + "description": "An amount discounting the line that has been allocated by a discount.\n", + "fields": [ + { + "name": "allocatedAmount", + "description": "Amount of discount allocated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplication", + "description": "The discount this allocated amount originated from.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "description": "Discount applications capture the intentions of a discount source at\nthe time of application.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "Which lines of targetType that the discount is allocated over.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of line that the discount is applicable towards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AutomaticDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ManualDiscountApplication", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ScriptDiscountApplication", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "description": "The method by which the discount's value is allocated onto its entitled lines.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ACROSS", + "description": "The value is spread across all entitled lines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EACH", + "description": "The value is applied onto every entitled line.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ONE", + "description": "The value is specifically applied onto a particular line.", + "isDeprecated": true, + "deprecationReason": "Use ACROSS instead." + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountApplicationConnection", + "description": "An auto-generated type for paginating through multiple DiscountApplications.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountApplicationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in DiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountApplicationEdge", + "description": "An auto-generated type which holds one DiscountApplication and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of DiscountApplicationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "description": "The lines on the order to which the discount is applied, of the type defined by\nthe discount application's `targetType`. For example, the value `ENTITLED`, combined with a `targetType` of\n`LINE_ITEM`, applies the discount on all line items that are entitled to the discount.\nThe value `ALL`, combined with a `targetType` of `SHIPPING_LINE`, applies the discount on all shipping lines.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": "The discount is allocated onto all the lines.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENTITLED", + "description": "The discount is allocated onto only the lines that it's entitled for.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EXPLICIT", + "description": "The discount is allocated onto explicitly chosen lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "description": "The type of line (i.e. line item or shipping line) on an order that the discount is applicable towards.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LINE_ITEM", + "description": "The discount applies onto line items.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHIPPING_LINE", + "description": "The discount applies onto shipping lines.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DiscountCodeApplication", + "description": "Discount code applications capture the intentions of a discount code at\nthe time that it is applied.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "applicable", + "description": "Specifies whether the discount code was applied successfully.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "code", + "description": "The string identifying the discount code that was used at the time of application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "Which lines of targetType that the discount is allocated over.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of line that the discount is applicable towards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "DisplayableError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "CartUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CheckoutUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDeleteUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UserError", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Domain", + "description": "Represents a web address.", + "fields": [ + { + "name": "host", + "description": "The host name of the domain (eg: `example.com`).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sslEnabled", + "description": "Whether SSL is enabled or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the domain (eg: `https://example.com`).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ExternalVideo", + "description": "Represents a video hosted outside of Shopify.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "embedUrl", + "description": "The embed URL of the video for the respective host.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "embeddedUrl", + "description": "The URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `originUrl` instead." + }, + { + "name": "host", + "description": "The host of the external video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaHost", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originUrl", + "description": "The origin URL of the video on the respective host.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentation", + "description": "The presentation for a media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Filter", + "description": "A filter that is supported on the parent field.", + "fields": [ + { + "name": "id", + "description": "A unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A human-friendly string for this filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "An enumeration that denotes the type of data this filter represents.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "FilterType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The list of values for this filter.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FilterValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilterType", + "description": "The type of data that the filter group represents.\n\nFor more information, refer to [Filter products in a collection with the Storefront API]\n(https://shopify.dev/custom-storefronts/products-collections/filter-products).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LIST", + "description": "A list of selectable values.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE_RANGE", + "description": "A range of prices.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOOLEAN", + "description": "A boolean value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FilterValue", + "description": "A selectable value within a filter.", + "fields": [ + { + "name": "count", + "description": "The number of results that match this filter value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "input", + "description": "An input object that can be used to filter by this value on the parent field.\n\nThe value is provided as a helper for building dynamic filtering UI. For\nexample, if you have a list of selected `FilterValue` objects, you can combine\ntheir respective `input` values to use in a subsequent query.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "label", + "description": "A human-friendly string for this filter value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Float", + "description": "Represents signed double-precision fractional values as specified by [IEEE 754](https://en.wikipedia.org/wiki/IEEE_floating_point).", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Fulfillment", + "description": "Represents a single fulfillment in an order.", + "fields": [ + { + "name": "fulfillmentLineItems", + "description": "List of the fulfillment's line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingCompany", + "description": "The name of the tracking company.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingInfo", + "description": "Tracking information associated with the fulfillment,\nsuch as the tracking number and tracking URL.\n", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfo", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "description": "Represents a single line item in a fulfillment. There is at most one fulfillment line item for each order line item.", + "fields": [ + { + "name": "lineItem", + "description": "The associated order's line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The amount fulfilled in this fulfillment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItemConnection", + "description": "An auto-generated type for paginating through multiple FulfillmentLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in FulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentLineItemEdge", + "description": "An auto-generated type which holds one FulfillmentLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of FulfillmentLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "FulfillmentLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "FulfillmentTrackingInfo", + "description": "Tracking information associated with the fulfillment.", + "fields": [ + { + "name": "number", + "description": "The tracking number of the fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL to track the fulfillment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "description": "The generic file resource lets you manage files in a merchant’s store. Generic files include any file that doesn’t fit into a designated type such as image or video. Example: PDF, JSON.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to indicate the contents of a file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The MIME type of the file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalFileSize", + "description": "The size of the original file in bytes.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the file.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "GeoCoordinateInput", + "description": "The input fields used to specify a geographical location.", + "fields": null, + "inputFields": [ + { + "name": "latitude", + "description": "The coordinate's latitude value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "longitude", + "description": "The coordinate's longitude value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "HTML", + "description": "A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a\ncomplete list of HTML elements.\n\nExample value: `\"

Grey cotton knit sweater.

\"`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "HasMetafields", + "description": "Represents information about the metafields associated to the specified resource.", + "fields": [ + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + ] + }, + { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "description": "The input fields to identify a metafield on an owner resource by namespace and key.", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "ID", + "description": "Represents a unique identifier, often used to refetch an object.\nThe ID type appears in a JSON response as a String, but it is not intended to be human-readable.\n\nExample value: `\"gid://shopify/Product/10079785100\"`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Image", + "description": "Represents an image resource.", + "fields": [ + { + "name": "altText", + "description": "A word or phrase to share the nature or contents of an image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The original height of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A unique ID for the image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalSrc", + "description": "The location of the original image as a URL.\n\nIf there are any existing transformations in the original source URL, they will remain and not be stripped.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url` instead." + }, + { + "name": "src", + "description": "The location of the image as a URL.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url` instead." + }, + { + "name": "transformedSrc", + "description": "The location of the transformed image as a URL.\n\nAll transformation arguments are considered \"best-effort\". If they can be applied to an image, they will be.\nOtherwise any transformations which an image type doesn't support will be ignored.\n", + "args": [ + { + "name": "crop", + "description": "Crops the image according to the specified region.", + "type": { + "kind": "ENUM", + "name": "CropRegion", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxHeight", + "description": "Image height in pixels between 1 and 5760.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxWidth", + "description": "Image width in pixels between 1 and 5760.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "preferredContentType", + "description": "Best effort conversion of image into content type (SVG -> PNG, Anything -> JPG, Anything -> WEBP are supported).", + "type": { + "kind": "ENUM", + "name": "ImageContentType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scale", + "description": "Image size multiplier for high-resolution retina displays. Must be between 1 and 3.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `url(transform:)` instead" + }, + { + "name": "url", + "description": "The location of the image as a URL.\n\nIf no transform options are specified, then the original image will be preserved including any pre-applied transforms.\n\nAll transformation options are considered \"best-effort\". Any transformation that the original image type doesn't support will be ignored.\n\nIf you need multiple variations of the same image, then you can use [GraphQL aliases](https://graphql.org/learn/queries/#aliases).\n", + "args": [ + { + "name": "transform", + "description": "A set of options to transform the original image.", + "type": { + "kind": "INPUT_OBJECT", + "name": "ImageTransformInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The original width of the image in pixels. Returns `null` if the image isn't hosted by Shopify.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ImageConnection", + "description": "An auto-generated type for paginating through multiple Images.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ImageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ImageContentType", + "description": "List of supported image content types.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PNG", + "description": "A PNG image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JPG", + "description": "A JPG image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEBP", + "description": "A WEBP image.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ImageEdge", + "description": "An auto-generated type which holds one Image and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ImageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ImageTransformInput", + "description": "The available options for transforming an image.\n\nAll transformation options are considered best effort. Any transformation that\nthe original image type doesn't support will be ignored.\n", + "fields": null, + "inputFields": [ + { + "name": "crop", + "description": "The region of the image to remain after cropping.\nMust be used in conjunction with the `maxWidth` and/or `maxHeight` fields,\nwhere the `maxWidth` and `maxHeight` aren't equal.\nThe `crop` argument should coincide with the smaller value. A smaller `maxWidth` indicates a `LEFT` or `RIGHT` crop, while\na smaller `maxHeight` indicates a `TOP` or `BOTTOM` crop. For example, `{\nmaxWidth: 5, maxHeight: 10, crop: LEFT }` will result\nin an image with a width of 5 and height of 10, where the right side of the image is removed.\n", + "type": { + "kind": "ENUM", + "name": "CropRegion", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxWidth", + "description": "Image width in pixels between 1 and 5760.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maxHeight", + "description": "Image height in pixels between 1 and 5760.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "scale", + "description": "Image size multiplier for high-resolution retina displays. Must be within 1..3.\n", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "preferredContentType", + "description": "Convert the source image into the preferred content type.\nSupported conversions: `.svg` to `.png`, any file type to `.jpg`, and any file type to `.webp`.\n", + "type": { + "kind": "ENUM", + "name": "ImageContentType", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Int", + "description": "Represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "JSON", + "description": "A [JSON](https://www.json.org/json-en.html) object.\n\nExample value:\n`{\n \"product\": {\n \"id\": \"gid://shopify/Product/1346443542550\",\n \"title\": \"White T-shirt\",\n \"options\": [{\n \"name\": \"Size\",\n \"values\": [\"M\", \"L\"]\n }]\n }\n}`\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Language", + "description": "A language.", + "fields": [ + { + "name": "endonymName", + "description": "The name of the language in the language itself. If the language uses capitalization, it is capitalized for a mid-sentence position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isoCode", + "description": "The ISO code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "LanguageCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the language in the current language.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LanguageCode", + "description": "ISO 639-1 language codes supported by Shopify.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AF", + "description": "Afrikaans.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AK", + "description": "Akan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AM", + "description": "Amharic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AR", + "description": "Arabic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AS", + "description": "Assamese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AZ", + "description": "Azerbaijani.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BE", + "description": "Belarusian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BG", + "description": "Bulgarian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BM", + "description": "Bambara.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BN", + "description": "Bangla.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BO", + "description": "Tibetan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BR", + "description": "Breton.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BS", + "description": "Bosnian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CA", + "description": "Catalan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CE", + "description": "Chechen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CKB", + "description": "Central Kurdish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CS", + "description": "Czech.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CY", + "description": "Welsh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DA", + "description": "Danish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DE", + "description": "German.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DZ", + "description": "Dzongkha.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EE", + "description": "Ewe.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EL", + "description": "Greek.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EN", + "description": "English.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EO", + "description": "Esperanto.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ES", + "description": "Spanish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ET", + "description": "Estonian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EU", + "description": "Basque.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FA", + "description": "Persian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FF", + "description": "Fulah.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FI", + "description": "Finnish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIL", + "description": "Filipino.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FO", + "description": "Faroese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FR", + "description": "French.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FY", + "description": "Western Frisian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GA", + "description": "Irish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GD", + "description": "Scottish Gaelic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GL", + "description": "Galician.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GU", + "description": "Gujarati.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GV", + "description": "Manx.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HA", + "description": "Hausa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HE", + "description": "Hebrew.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HI", + "description": "Hindi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HR", + "description": "Croatian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HU", + "description": "Hungarian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HY", + "description": "Armenian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IA", + "description": "Interlingua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Indonesian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IG", + "description": "Igbo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "II", + "description": "Sichuan Yi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IS", + "description": "Icelandic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IT", + "description": "Italian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JA", + "description": "Japanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "JV", + "description": "Javanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KA", + "description": "Georgian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KI", + "description": "Kikuyu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KK", + "description": "Kazakh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KL", + "description": "Kalaallisut.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KM", + "description": "Khmer.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KN", + "description": "Kannada.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KO", + "description": "Korean.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KS", + "description": "Kashmiri.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KU", + "description": "Kurdish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KW", + "description": "Cornish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KY", + "description": "Kyrgyz.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LB", + "description": "Luxembourgish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LG", + "description": "Ganda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LN", + "description": "Lingala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LO", + "description": "Lao.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LT", + "description": "Lithuanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LU", + "description": "Luba-Katanga.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LV", + "description": "Latvian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "Malagasy.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MI", + "description": "Māori.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MK", + "description": "Macedonian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ML", + "description": "Malayalam.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MN", + "description": "Mongolian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MR", + "description": "Marathi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MS", + "description": "Malay.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MT", + "description": "Maltese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MY", + "description": "Burmese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NB", + "description": "Norwegian (Bokmål).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ND", + "description": "North Ndebele.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NE", + "description": "Nepali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NL", + "description": "Dutch.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NN", + "description": "Norwegian Nynorsk.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO", + "description": "Norwegian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OM", + "description": "Oromo.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OR", + "description": "Odia.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OS", + "description": "Ossetic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PA", + "description": "Punjabi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PL", + "description": "Polish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PS", + "description": "Pashto.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT_BR", + "description": "Portuguese (Brazil).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT_PT", + "description": "Portuguese (Portugal).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QU", + "description": "Quechua.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RM", + "description": "Romansh.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RN", + "description": "Rundi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RO", + "description": "Romanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RU", + "description": "Russian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RW", + "description": "Kinyarwanda.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SA", + "description": "Sanskrit.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SC", + "description": "Sardinian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SD", + "description": "Sindhi.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SE", + "description": "Northern Sami.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SG", + "description": "Sango.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SI", + "description": "Sinhala.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SK", + "description": "Slovak.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SL", + "description": "Slovenian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SN", + "description": "Shona.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SO", + "description": "Somali.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SQ", + "description": "Albanian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SR", + "description": "Serbian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SU", + "description": "Sundanese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SV", + "description": "Swedish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SW", + "description": "Swahili.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TA", + "description": "Tamil.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TE", + "description": "Telugu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TG", + "description": "Tajik.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TH", + "description": "Thai.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TI", + "description": "Tigrinya.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TK", + "description": "Turkmen.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TO", + "description": "Tongan.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TR", + "description": "Turkish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TT", + "description": "Tatar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UG", + "description": "Uyghur.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UK", + "description": "Ukrainian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UR", + "description": "Urdu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UZ", + "description": "Uzbek.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VI", + "description": "Vietnamese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WO", + "description": "Wolof.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "XH", + "description": "Xhosa.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YI", + "description": "Yiddish.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "YO", + "description": "Yoruba.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH_CN", + "description": "Chinese (Simplified).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH_TW", + "description": "Chinese (Traditional).", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZU", + "description": "Zulu.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ZH", + "description": "Chinese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PT", + "description": "Portuguese.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CU", + "description": "Church Slavic.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VO", + "description": "Volapük.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LA", + "description": "Latin.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SH", + "description": "Serbo-Croatian.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MO", + "description": "Moldavian.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Localization", + "description": "Information about the localized experiences configured for the shop.", + "fields": [ + { + "name": "availableCountries", + "description": "The list of countries with enabled localized experiences.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Country", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "availableLanguages", + "description": "The list of languages available for the active country.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Language", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the active localized experience. Use the `@inContext` directive to change this value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Country", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "language", + "description": "The language of the active localized experience. Use the `@inContext` directive to change this value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Language", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "market", + "description": "The market including the country of the active localized experience. Use the `@inContext` directive to change this value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Market", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Location", + "description": "Represents a location where product inventory is held.", + "fields": [ + { + "name": "address", + "description": "The address of the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationAddress", + "description": "Represents the address of a location.\n", + "fields": [ + { + "name": "address1", + "description": "The first line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address for the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The country code of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formatted", + "description": "A formatted version of the address for the location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "The latitude coordinates of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude coordinates of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone number of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The province of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The code for the province, state, or district of the address of the location.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The ZIP code of the location.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationConnection", + "description": "An auto-generated type for paginating through multiple Locations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in LocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "LocationEdge", + "description": "An auto-generated type which holds one Location and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of LocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LocationSortKeys", + "description": "The set of valid sort keys for the Location query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CITY", + "description": "Sort by the `city` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISTANCE", + "description": "Sort by the `distance` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "Sort by the `name` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddress", + "description": "Represents a mailing address for customers and shipping.", + "fields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "company", + "description": "The name of the customer's company or organization.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The name of the country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `countryCodeV2` instead." + }, + { + "name": "countryCodeV2", + "description": "The two-letter code for the country of the address.\n\nFor example, US.\n", + "args": [], + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstName", + "description": "The first name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formatted", + "description": "A formatted version of the address, customized by the provided arguments.", + "args": [ + { + "name": "withCompany", + "description": "Whether to include the customer's company in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "withName", + "description": "Whether to include the customer's name in the formatted address.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "formattedArea", + "description": "A comma-separated list of the values for city, province, and country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastName", + "description": "The last name of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "The latitude coordinate of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "The longitude coordinate of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The full name of the customer, based on firstName and lastName.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "provinceCode", + "description": "The two-letter code for the region.\n\nFor example, ON.\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddressConnection", + "description": "An auto-generated type for paginating through multiple MailingAddresses.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddressEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MailingAddressEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MailingAddressEdge", + "description": "An auto-generated type which holds one MailingAddress and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MailingAddressEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "description": "The input fields to create or update a mailing address.", + "fields": null, + "inputFields": [ + { + "name": "address1", + "description": "The first line of the address. Typically the street address or PO Box number.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The second line of the address. Typically the number of the apartment, suite, or unit.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The name of the city, district, village, or town.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "company", + "description": "The name of the customer's company or organization.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country", + "description": "The name of the country.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "firstName", + "description": "The first name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "lastName", + "description": "The last name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": "A unique phone number for the customer.\n\nFormatted using E.164 standard. For example, _+16135551111_.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "province", + "description": "The region of the address, such as the province, state, or district.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "zip", + "description": "The zip or postal code of the address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ManualDiscountApplication", + "description": "Manual discount applications capture the intentions of a discount that was manually created.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the application.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "Which lines of targetType that the discount is allocated over.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of line that the discount is applicable towards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Market", + "description": "A group of one or more regions of the world that a merchant is targeting for sales. To learn more about markets, refer to [the Shopify Markets conceptual overview](/docs/apps/markets).", + "fields": [ + { + "name": "handle", + "description": "A human-readable unique string for the market automatically generated from its title.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Media", + "description": "Represents a media interface.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentation", + "description": "The presentation for a media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ExternalVideo", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MediaConnection", + "description": "An auto-generated type for paginating through multiple Media.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MediaEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaContentType", + "description": "The possible content types for a media object.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "EXTERNAL_VIDEO", + "description": "An externally hosted video.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "A Shopify hosted image.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MODEL_3D", + "description": "A 3d model.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIDEO", + "description": "A Shopify hosted video.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaEdge", + "description": "An auto-generated type which holds one Media and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MediaEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaHost", + "description": "Host for a Media Resource.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "YOUTUBE", + "description": "Host for YouTube embedded videos.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VIMEO", + "description": "Host for Vimeo embedded videos.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "description": "Represents a Shopify hosted image.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentation", + "description": "The presentation for a media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MediaPresentation", + "description": "A media presentation.", + "fields": [ + { + "name": "asJson", + "description": "A JSON object representing a presentation view.", + "args": [ + { + "name": "format", + "description": "The format to transform the settings.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaPresentationFormat", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "JSON", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MediaPresentationFormat", + "description": "The possible formats for a media presentation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MODEL_VIEWER", + "description": "A model viewer presentation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMAGE", + "description": "A media image presentation.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Menu", + "description": "A [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) representing a hierarchy\nof hyperlinks (items).\n", + "fields": [ + { + "name": "handle", + "description": "The menu's handle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The menu's child items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MenuItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "itemsCount", + "description": "The count of items on the menu.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The menu's title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MenuItem", + "description": "A menu item within a parent menu.", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The menu item's child items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MenuItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resource", + "description": "The linked resource.", + "args": [], + "type": { + "kind": "UNION", + "name": "MenuItemResource", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "resourceId", + "description": "The ID of the linked resource.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "The menu item's tags to filter a collection.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The menu item's title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The menu item's type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MenuItemType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The menu item's URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "MenuItemResource", + "description": "The list of possible resources a `MenuItem` can reference.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + } + ] + }, + { + "kind": "ENUM", + "name": "MenuItemType", + "description": "A menu item type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "FRONTPAGE", + "description": "A frontpage link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION", + "description": "A collection link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTIONS", + "description": "A collection link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "A product link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATALOG", + "description": "A catalog link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAGE", + "description": "A page link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BLOG", + "description": "A blog link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARTICLE", + "description": "An article link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEARCH", + "description": "A search link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOP_POLICY", + "description": "A shop policy link.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HTTP", + "description": "An http link.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "Merchandise", + "description": "The merchandise to be purchased at checkout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Metafield", + "description": "Metafields represent custom metadata attached to a resource. Metafields can be sorted into namespaces and are\ncomprised of keys, values, and value types.\n", + "fields": [ + { + "name": "createdAt", + "description": "The date and time when the storefront metafield was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of a metafield.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "key", + "description": "The unique identifier for the metafield within its namespace.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "namespace", + "description": "The container for a group of metafields that the metafield is associated with.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentResource", + "description": "The type of resource that the metafield is attached to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldParentResource", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference", + "description": "Returns a reference object if the metafield's type is a resource reference.", + "args": [], + "type": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "references", + "description": "A list of reference objects if the metafield's type is a resource reference list.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type name of the metafield.\nRefer to the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the metafield was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The data stored in the metafield. Always stored as a string, regardless of the metafield's type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldDeleteErrorCode", + "description": "Possible error codes that can be returned by `MetafieldDeleteUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "INVALID_OWNER", + "description": "The owner ID is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METAFIELD_DOES_NOT_EXIST", + "description": "Metafield not found.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldDeleteUserError", + "description": "An error that occurs during the execution of cart metafield deletion.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldDeleteErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetafieldFilter", + "description": "A filter used to view a subset of products in a collection matching a specific metafield value.\n\nOnly the following metafield types are currently supported:\n- `number_integer`\n- `number_decimal`\n- `single_line_text_field`\n- `boolean` as of 2022-04.\n", + "fields": null, + "inputFields": [ + { + "name": "key", + "description": "The key of the metafield to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The namespace of the metafield to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "MetafieldParentResource", + "description": "A resource that the metafield belongs to.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + ] + }, + { + "kind": "UNION", + "name": "MetafieldReference", + "description": "Returns the resource which is being referred to by a metafield.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "description": "An auto-generated type for paginating through multiple MetafieldReferences.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetafieldReferenceEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetafieldReferenceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldReferenceEdge", + "description": "An auto-generated type which holds one MetafieldReference and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetafieldReferenceEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetafieldsSetUserError", + "description": "An error that occurs during the execution of `MetafieldsSet`.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "ENUM", + "name": "MetafieldsSetUserErrorCode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "elementIndex", + "description": "The index of the array element that's causing the error.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "MetafieldsSetUserErrorCode", + "description": "Possible error codes that can be returned by `MetafieldsSetUserError`.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BLANK", + "description": "The input value is blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INCLUSION", + "description": "The input value isn't included in the list.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LESS_THAN_OR_EQUAL_TO", + "description": "The input value should be less than or equal to the maximum value allowed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRESENT", + "description": "The input value needs to be blank.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_SHORT", + "description": "The input value is too short.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOO_LONG", + "description": "The input value is too long.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_OWNER", + "description": "The owner ID is invalid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_VALUE", + "description": "The value is invalid for metafield type or for definition options.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TYPE", + "description": "The type is invalid.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "description": "An instance of a user-defined model based on a MetaobjectDefinition.", + "fields": [ + { + "name": "field", + "description": "Accesses a field of the object by key.", + "args": [ + { + "name": "key", + "description": "The key of the field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetaobjectField", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": "All object fields with defined values.\nOmitted object keys can be assumed null, and no guarantees are made about field order.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectField", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The unique handle of the metaobject. Useful as a custom ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the metaobject. Defines the namespace of its associated metafields.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the metaobject was last updated.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectConnection", + "description": "An auto-generated type for paginating through multiple Metaobjects.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in MetaobjectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectEdge", + "description": "An auto-generated type which holds one Metaobject and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of MetaobjectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MetaobjectField", + "description": "Provides the value of a Metaobject field.", + "fields": [ + { + "name": "key", + "description": "The field key.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reference", + "description": "A referenced object if the field type is a resource reference.", + "args": [], + "type": { + "kind": "UNION", + "name": "MetafieldReference", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "references", + "description": "A list of referenced objects if the field type is a resource reference list.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "MetafieldReferenceConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type name of the field.\nSee the list of [supported types](https://shopify.dev/apps/metafields/definitions/types).\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The field value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MetaobjectHandleInput", + "description": "The input fields used to retrieve a metaobject by handle.", + "fields": null, + "inputFields": [ + { + "name": "handle", + "description": "The handle of the metaobject.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The type of the metaobject.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "description": "Represents a Shopify hosted 3D model.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentation", + "description": "The presentation for a media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sources", + "description": "The sources for a 3d model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Model3dSource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Model3dSource", + "description": "Represents a source for a Shopify hosted 3d model.", + "fields": [ + { + "name": "filesize", + "description": "The filesize of the 3d model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "format", + "description": "The format of the 3d model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The MIME type of the 3d model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the 3d model.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "description": "The input fields for a monetary value with currency.", + "fields": null, + "inputFields": [ + { + "name": "amount", + "description": "Decimal money amount.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "currencyCode", + "description": "Currency of the money.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MoneyV2", + "description": "A monetary value with currency.\n", + "fields": [ + { + "name": "amount", + "description": "Decimal money amount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "Currency of the money.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Mutation", + "description": "The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.", + "fields": [ + { + "name": "cartAttributesUpdate", + "description": "Updates the attributes on a cart.", + "args": [ + { + "name": "attributes", + "description": "An array of key-value pairs that contains additional information about the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartAttributesUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartBuyerIdentityUpdate", + "description": "Updates customer information associated with a cart.\nBuyer identity is used to determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing)\nand should match the customer's shipping address.\n", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "buyerIdentity", + "description": "The customer associated with the cart. Used to determine\n[international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing).\nBuyer identity should match the customer's shipping address.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartBuyerIdentityInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartBuyerIdentityUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartCreate", + "description": "Creates a new cart.", + "args": [ + { + "name": "input", + "description": "The fields used to create a cart.", + "type": { + "kind": "INPUT_OBJECT", + "name": "CartInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartDiscountCodesUpdate", + "description": "Updates the discount codes applied to the cart.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "discountCodes", + "description": "The case-insensitive discount codes that the customer added at checkout.\n", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartDiscountCodesUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartLinesAdd", + "description": "Adds a merchandise line to the cart.", + "args": [ + { + "name": "lines", + "description": "A list of merchandise lines to add to the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartLineInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartLinesAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartLinesRemove", + "description": "Removes one or more merchandise lines from the cart.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineIds", + "description": "The merchandise line IDs to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartLinesRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartLinesUpdate", + "description": "Updates one or more merchandise lines on a cart.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lines", + "description": "The merchandise lines to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartLineUpdateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartLinesUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartMetafieldDelete", + "description": "Deletes a cart metafield.", + "args": [ + { + "name": "input", + "description": "The input fields used to delete a cart metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartMetafieldDeleteInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartMetafieldDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartMetafieldsSet", + "description": "Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not.\n\nAllows a maximum of 25 cart metafields to be set at a time.\n", + "args": [ + { + "name": "metafields", + "description": "The list of Cart metafield values to set. Maximum of 25.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartMetafieldsSetInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartMetafieldsSetPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartNoteUpdate", + "description": "Updates the note on the cart.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "note", + "description": "The note on the cart.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartNoteUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartPaymentUpdate", + "description": "Update the customer's payment method that will be used to checkout.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment", + "description": "The payment information for the cart that will be used at checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartPaymentInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartPaymentUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartSelectedDeliveryOptionsUpdate", + "description": "Update the selected delivery options for a delivery group.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selectedDeliveryOptions", + "description": "The selected delivery options.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CartSelectedDeliveryOptionInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartSelectedDeliveryOptionsUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartSubmitForCompletion", + "description": "Submit the cart for checkout completion.", + "args": [ + { + "name": "cartId", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "attemptToken", + "description": "The attemptToken is used to guarantee an idempotent result.\nIf more than one call uses the same attemptToken within a short period of time, only one will be accepted.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CartSubmitForCompletionPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutAttributesUpdateV2", + "description": "Updates the attributes of a checkout if `allowPartialAddresses` is `true`.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The checkout attributes to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutAttributesUpdateV2Input", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutAttributesUpdateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCompleteFree", + "description": "Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCompleteFreePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCompleteWithCreditCardV2", + "description": "Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://shopify.dev/apps/channels/getting-started#request-payment-processing).", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment", + "description": "The credit card info to apply as a payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreditCardPaymentInputV2", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCompleteWithCreditCardV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCompleteWithTokenizedPaymentV3", + "description": "Completes a checkout with a tokenized payment.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment", + "description": "The info to apply as a tokenized payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "TokenizedPaymentInputV3", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCompleteWithTokenizedPaymentV3Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCreate", + "description": "Creates a new checkout.", + "args": [ + { + "name": "input", + "description": "The fields used to create a checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutCreateInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "queueToken", + "description": "The checkout queue token. Available only to selected stores.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCustomerAssociateV2", + "description": "Associates a customer to the checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token of the customer to associate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCustomerAssociateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCustomerDisassociateV2", + "description": "Disassociates the current checkout customer from the checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutCustomerDisassociateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutDiscountCodeApplyV2", + "description": "Applies a discount to an existing checkout using a discount code.", + "args": [ + { + "name": "discountCode", + "description": "The discount code to apply to the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutDiscountCodeApplyV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutDiscountCodeRemove", + "description": "Removes the applied discounts from an existing checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutDiscountCodeRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutEmailUpdateV2", + "description": "Updates the email on an existing checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email to update the checkout with.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutEmailUpdateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutGiftCardRemoveV2", + "description": "Removes an applied gift card from the checkout.", + "args": [ + { + "name": "appliedGiftCardId", + "description": "The ID of the Applied Gift Card to remove from the Checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutGiftCardRemoveV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutGiftCardsAppend", + "description": "Appends gift cards to an existing checkout.", + "args": [ + { + "name": "giftCardCodes", + "description": "A list of gift card codes to append to the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutGiftCardsAppendPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutLineItemsAdd", + "description": "Adds a list of line items to a checkout.", + "args": [ + { + "name": "lineItems", + "description": "A list of line item objects to add to the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutLineItemsAddPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutLineItemsRemove", + "description": "Removes line items from an existing checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The checkout on which to remove line items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "lineItemIds", + "description": "Line item ids to remove.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutLineItemsRemovePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutLineItemsReplace", + "description": "Sets a list of line items to a checkout.", + "args": [ + { + "name": "lineItems", + "description": "A list of line item objects to set on the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutLineItemsReplacePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutLineItemsUpdate", + "description": "Updates line items on a checkout.", + "args": [ + { + "name": "lineItems", + "description": "Line items to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutLineItemUpdateInput", + "ofType": null + } + } + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The checkout on which to update line items.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutLineItemsUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutShippingAddressUpdateV2", + "description": "Updates the shipping address of an existing checkout.", + "args": [ + { + "name": "shippingAddress", + "description": "The shipping address to where the line items will be shipped.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutShippingAddressUpdateV2Payload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutShippingLineUpdate", + "description": "Updates the shipping lines on an existing checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The ID of the checkout.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "shippingRateHandle", + "description": "A unique identifier to a Checkout’s shipping provider, price, and title combination, enabling the customer to select the availableShippingRates.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CheckoutShippingLineUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenCreate", + "description": "Creates a customer access token.\nThe customer access token is required to modify the customer object in any way.\n", + "args": [ + { + "name": "input", + "description": "The fields used to create a customer access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAccessTokenCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessTokenCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenCreateWithMultipass", + "description": "Creates a customer access token using a\n[multipass token](https://shopify.dev/api/multipass) instead of email and\npassword. A customer record is created if the customer doesn't exist. If a customer\nrecord already exists but the record is disabled, then the customer record is enabled.\n", + "args": [ + { + "name": "multipassToken", + "description": "A valid [multipass token](https://shopify.dev/api/multipass) to be authenticated.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessTokenCreateWithMultipassPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenDelete", + "description": "Permanently destroys a customer access token.", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessTokenDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenRenew", + "description": "Renews a customer access token.\n\nAccess token renewal must happen *before* a token expires.\nIf a token has already expired, a new one should be created instead via `customerAccessTokenCreate`.\n", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessTokenRenewPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerActivate", + "description": "Activates a customer.", + "args": [ + { + "name": "id", + "description": "Specifies the customer to activate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The fields used to activate a customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerActivateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerActivatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerActivateByUrl", + "description": "Activates a customer with the activation url received from `customerCreate`.", + "args": [ + { + "name": "activationUrl", + "description": "The customer activation URL.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "A new password set during activation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerActivateByUrlPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddressCreate", + "description": "Creates a new address for a customer.", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "address", + "description": "The customer mailing address to create.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddressDelete", + "description": "Permanently deletes the address of an existing customer.", + "args": [ + { + "name": "id", + "description": "Specifies the address to delete.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressDeletePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddressUpdate", + "description": "Updates the address of an existing customer.", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "Specifies the customer address to update.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "address", + "description": "The customer’s mailing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCreate", + "description": "Creates a new customer.", + "args": [ + { + "name": "input", + "description": "The fields used to create a new customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerCreatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerDefaultAddressUpdate", + "description": "Updates the default address of an existing customer.", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "addressId", + "description": "ID of the address to set as the new default for the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerDefaultAddressUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerRecover", + "description": "Sends a reset password email to the customer. The reset password\nemail contains a reset password URL and token that you can pass to\nthe [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or\n[`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the\ncustomer password.\n\nThis mutation is throttled by IP. With private access,\nyou can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP.\nThe header is case-sensitive and must be sent as `Shopify-Storefront-Buyer-IP`.\n\nMake sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this\nmutation presents a security risk.\n", + "args": [ + { + "name": "email", + "description": "The email address of the customer to recover.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerRecoverPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerReset", + "description": "\"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation.\"\n", + "args": [ + { + "name": "id", + "description": "Specifies the customer to reset.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The fields used to reset a customer’s password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerResetInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerResetPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerResetByUrl", + "description": "\"Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation.\"\n", + "args": [ + { + "name": "resetUrl", + "description": "The customer's reset password url.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": "New password that will be set as part of the reset password process.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerResetByUrlPayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUpdate", + "description": "Updates an existing customer.", + "args": [ + { + "name": "customerAccessToken", + "description": "The access token used to identify the customer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customer", + "description": "The customer object input.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerUpdatePayload", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "description": "An object with an ID field to support global identification, in accordance with the\n[Relay specification](https://relay.dev/graphql/objectidentification.htm#sec-Node-Interface).\nThis interface is used by the [node](https://shopify.dev/api/admin-graphql/unstable/queries/node)\nand [nodes](https://shopify.dev/api/admin-graphql/unstable/queries/nodes) queries.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "AppliedGiftCard", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CartLine", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CheckoutLineItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Comment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ComponentizableCartLine", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ExternalVideo", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "GenericFile", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Location", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Market", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Menu", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MenuItem", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Model3d", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Order", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Payment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Video", + "ofType": null + } + ] + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "description": "Represents a resource that can be published to the Online Store sales channel.", + "fields": [ + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Order", + "description": "An order is a customer’s completed request to purchase one or more products from a shop. An order is created when a customer completes the checkout process, during which time they provides an email address, billing address and payment information.", + "fields": [ + { + "name": "billingAddress", + "description": "The address associated with the payment method.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cancelReason", + "description": "The reason for the order's cancellation. Returns `null` if the order wasn't canceled.", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderCancelReason", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "canceledAt", + "description": "The date and time when the order was canceled. Returns null if the order wasn't canceled.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The code of the currency used for the payment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentSubtotalPrice", + "description": "The subtotal of line items and their discounts, excluding line items that have been removed. Does not contain order-level discounts, duties, shipping costs, or shipping discounts. Taxes aren't included unless the order is a taxes-included order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalDuties", + "description": "The total cost of duties for the order, including refunds.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalPrice", + "description": "The total amount of the order, including duties, taxes and discounts, minus amounts for line items that have been removed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentTotalTax", + "description": "The total of all taxes applied to the order, excluding taxes for returned line items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "A list of the custom attributes added to the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerLocale", + "description": "The locale code in which this specific order happened.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUrl", + "description": "The unique URL that the customer can use to access the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountApplications", + "description": "Discounts that have been applied on the order.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountApplicationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "edited", + "description": "Whether the order has had any edits applied or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The customer's email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "financialStatus", + "description": "The financial status of the order.", + "args": [], + "type": { + "kind": "ENUM", + "name": "OrderFinancialStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fulfillmentStatus", + "description": "The fulfillment status for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderFulfillmentStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lineItems", + "description": "List of the order’s line items.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderLineItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Unique identifier for the order that appears on the order.\nFor example, _#1000_ or _Store1001.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderNumber", + "description": "A unique numeric identifier for the order for use by shop owner and customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalDuties", + "description": "The total cost of duties charged at checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalPrice", + "description": "The total price of the order before any applied edits.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The customer's phone number for receiving SMS notifications.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "processedAt", + "description": "The date and time when the order was imported.\nThis value can be set to dates in the past when importing from other systems.\nIf no value is provided, it will be auto-generated based on current date and time.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingAddress", + "description": "The address to where the order will be shipped.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDiscountAllocations", + "description": "The discounts that have been allocated onto the shipping line by discount applications.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusUrl", + "description": "The unique URL for the order's status page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPrice", + "description": "Price of the order before shipping and taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotalPriceV2", + "description": "Price of the order before duties, shipping and taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `subtotalPrice` instead." + }, + { + "name": "successfulFulfillments", + "description": "List of the order’s successful fulfillments.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Fulfillment", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPrice", + "description": "The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalPriceV2", + "description": "The sum of all the prices of all the items in the order, duties, taxes and discounts included (must be positive).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalPrice` instead." + }, + { + "name": "totalRefunded", + "description": "The total amount that has been refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalRefundedV2", + "description": "The total amount that has been refunded.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalRefunded` instead." + }, + { + "name": "totalShippingPrice", + "description": "The total cost of shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalShippingPriceV2", + "description": "The total cost of shipping.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `totalShippingPrice` instead." + }, + { + "name": "totalTax", + "description": "The total cost of taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalTaxV2", + "description": "The total cost of taxes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `totalTax` instead." + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderCancelReason", + "description": "Represents the reason for the order's cancellation.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CUSTOMER", + "description": "The customer wanted to cancel the order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAUD", + "description": "The order was fraudulent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVENTORY", + "description": "There was insufficient inventory.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DECLINED", + "description": "Payment was declined.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OTHER", + "description": "The order was canceled for an unlisted reason.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderConnection", + "description": "An auto-generated type for paginating through multiple Orders.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in OrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total count of Orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "UnsignedInt64", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderEdge", + "description": "An auto-generated type which holds one Order and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of OrderEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderFinancialStatus", + "description": "Represents the order's current financial status.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "Displayed as **Pending**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "Displayed as **Authorized**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_PAID", + "description": "Displayed as **Partially paid**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_REFUNDED", + "description": "Displayed as **Partially refunded**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VOIDED", + "description": "Displayed as **Voided**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAID", + "description": "Displayed as **Paid**.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REFUNDED", + "description": "Displayed as **Refunded**.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderFulfillmentStatus", + "description": "Represents the order's aggregated fulfillment status for display purposes.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "UNFULFILLED", + "description": "Displayed as **Unfulfilled**. None of the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTIALLY_FULFILLED", + "description": "Displayed as **Partially fulfilled**. Some of the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FULFILLED", + "description": "Displayed as **Fulfilled**. All of the items in the order have been fulfilled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESTOCKED", + "description": "Displayed as **Restocked**. All of the items in the order have been restocked. Replaced by \"UNFULFILLED\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PENDING_FULFILLMENT", + "description": "Displayed as **Pending fulfillment**. A request for fulfillment of some items awaits a response from the fulfillment service. Replaced by \"IN_PROGRESS\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPEN", + "description": "Displayed as **Open**. None of the items in the order have been fulfilled. Replaced by \"UNFULFILLED\" status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IN_PROGRESS", + "description": "Displayed as **In progress**. Some of the items in the order have been fulfilled, or a request for fulfillment has been sent to the fulfillment service.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ON_HOLD", + "description": "Displayed as **On hold**. All of the unfulfilled items in this order are on hold.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEDULED", + "description": "Displayed as **Scheduled**. All of the unfulfilled items in this order are scheduled for fulfillment at later time.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderLineItem", + "description": "Represents a single line in an order. There is one line item for each distinct product variant.", + "fields": [ + { + "name": "currentQuantity", + "description": "The number of entries associated to the line item minus the items that have been removed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customAttributes", + "description": "List of custom attributes associated to the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountAllocations", + "description": "The discounts that have been allocated onto the order line item by discount applications.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "DiscountAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountedTotalPrice", + "description": "The total price of the line item, including discounts, and displayed in the presentment currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "originalTotalPrice", + "description": "The total price of the line item, not including any discounts. The total price is calculated using the original unit price multiplied by the quantity, and it's displayed in the presentment currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of products variants associated to the line item.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the product combined with title of the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variant", + "description": "The product variant object associated to the line item.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderLineItemConnection", + "description": "An auto-generated type for paginating through multiple OrderLineItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderLineItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in OrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderLineItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderLineItemEdge", + "description": "An auto-generated type which holds one OrderLineItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of OrderLineItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderLineItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderSortKeys", + "description": "The set of valid sort keys for the Order query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PROCESSED_AT", + "description": "Sort by the `processed_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TOTAL_PRICE", + "description": "Sort by the `total_price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Page", + "description": "Shopify merchants can create pages to hold static HTML content. Each Page object represents a custom page on the online store.", + "fields": [ + { + "name": "body", + "description": "The description of the page, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bodySummary", + "description": "Summary of the page body.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The timestamp of the page creation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A human-friendly unique string for the page automatically generated from its title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "The page's SEO information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The timestamp of the latest page update.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Trackable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PageConnection", + "description": "An auto-generated type for paginating through multiple Pages.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in PageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Page", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PageEdge", + "description": "An auto-generated type which holds one Page and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of PageEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Page", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PageInfo", + "description": "Returns information about pagination in a connection, in accordance with the\n[Relay specification](https://relay.dev/graphql/connections.htm#sec-undefined.PageInfo).\nFor more information, please read our [GraphQL Pagination Usage Guide](https://shopify.dev/api/usage/pagination-graphql).\n", + "fields": [ + { + "name": "endCursor", + "description": "The cursor corresponding to the last node in edges.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasNextPage", + "description": "Whether there are more pages to fetch following the current page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasPreviousPage", + "description": "Whether there are any pages prior to the current page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startCursor", + "description": "The cursor corresponding to the first node in edges.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PageSortKeys", + "description": "The set of valid sort keys for the Page query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Payment", + "description": "A payment applied to a checkout.", + "fields": [ + { + "name": "amount", + "description": "The amount of the payment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountV2", + "description": "The amount of the payment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amount` instead." + }, + { + "name": "billingAddress", + "description": "The billing address for the payment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MailingAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkout", + "description": "The checkout to which the payment belongs.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creditCard", + "description": "The credit card used for the payment in the case of direct payments.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CreditCard", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errorMessage", + "description": "A message describing a processing error during asynchronous processing.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "idempotencyKey", + "description": "A client-side generated token to identify a payment and perform idempotent operations.\nFor more information, refer to\n[Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).\n", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nextActionUrl", + "description": "The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ready", + "description": "Whether the payment is still processing asynchronously.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "A flag to indicate if the payment is to be done in test mode for gateways that support it.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "transaction", + "description": "The actual transaction recorded by Shopify after having processed the payment with the gateway.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Transaction", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PaymentSettings", + "description": "Settings related to payments.", + "fields": [ + { + "name": "acceptedCardBrands", + "description": "List of the card brands which the shop accepts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CardBrand", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cardVaultUrl", + "description": "The url pointing to the endpoint to vault credit cards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "countryCode", + "description": "The country where the shop is located.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currencyCode", + "description": "The three-letter code for the shop's primary currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enabledPresentmentCurrencies", + "description": "A list of enabled currencies (ISO 4217 format) that the shop accepts.\nMerchants can enable currencies from their Shopify Payments settings in the Shopify admin.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CurrencyCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopifyPaymentsAccountId", + "description": "The shop’s Shopify Payments account ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "supportedDigitalWallets", + "description": "List of the digital wallets which the shop supports.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DigitalWallet", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PaymentTokenType", + "description": "The valid values for the types of payment token.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "APPLE_PAY", + "description": "Apple Pay token type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VAULT", + "description": "Vault payment token type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SHOPIFY_PAY", + "description": "Shopify Pay token type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GOOGLE_PAY", + "description": "Google Pay token type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STRIPE_VAULT_TOKEN", + "description": "Stripe token type.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PredictiveSearchLimitScope", + "description": "Decides the distribution of results.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": "Return results up to limit across all types.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EACH", + "description": "Return results up to limit per type.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PredictiveSearchResult", + "description": "A predictive search result represents a list of products, collections, pages, articles, and query suggestions\nthat matches the predictive search query.\n", + "fields": [ + { + "name": "articles", + "description": "The articles that match the search query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Article", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collections", + "description": "The articles that match the search query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pages", + "description": "The pages that match the search query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Page", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The products that match the search query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queries", + "description": "The query suggestions that are relevant to the search query.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchQuerySuggestion", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PredictiveSearchType", + "description": "The types of search items to perform predictive search on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "COLLECTION", + "description": "Returns matching collections.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": "Returns matching products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAGE", + "description": "Returns matching pages.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARTICLE", + "description": "Returns matching articles.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "QUERY", + "description": "Returns matching query strings.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PriceRangeFilter", + "description": "The input fields for a filter used to view a subset of products in a collection matching a specific price range.\n", + "fields": null, + "inputFields": [ + { + "name": "max", + "description": "The maximum price in the range. Empty indicates no max price.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "min", + "description": "The minimum price in the range. Defaults to zero.", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": "0.0" + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PricingPercentageValue", + "description": "The value of the percentage pricing object.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the object.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "PricingValue", + "description": "The price value (fixed or percentage) for a discount application.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "PricingPercentageValue", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Product", + "description": "A product represents an individual item for sale in a Shopify store. Products are often physical, but they don't have to be.\nFor example, a digital download (such as a movie, music or ebook file) also\nqualifies as a product, as do services (such as equipment rental, work for hire,\ncustomization of another product or an extended warranty).\n", + "fields": [ + { + "name": "availableForSale", + "description": "Indicates if at least one product variant is available for sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collections", + "description": "List of collections a product belongs to.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtPriceRange", + "description": "The compare at price of the product across all variants.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date and time when the product was created.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "Stripped description of the product, single line with HTML tags removed.", + "args": [ + { + "name": "truncateAt", + "description": "Truncates string after the given length.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "descriptionHtml", + "description": "The description of the product, complete with HTML formatting.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "HTML", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "featuredImage", + "description": "The featured image for the product.\n\nThis field is functionally equivalent to `images(first: 1)`.\n", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "A human-friendly unique string for the Product automatically generated from its title.\nThey are used by the Liquid templating language to refer to objects.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "List of images associated with the product.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductImageSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ImageConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isGiftCard", + "description": "Whether the product is a gift card.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "media", + "description": "The media associated with the product.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductMediaSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MediaConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onlineStoreUrl", + "description": "The URL used for viewing the resource on the shop's Online Store. Returns `null` if the resource is currently not published to the Online Store sales channel.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "List of product options.", + "args": [ + { + "name": "first", + "description": "Truncate the array result to this size.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRange", + "description": "The price range.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductPriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productType", + "description": "A categorization that a product can be tagged with, commonly used for filtering and searching.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publishedAt", + "description": "The date and time when the product was published to the channel.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresSellingPlan", + "description": "Whether the product can only be purchased with a selling plan.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanGroups", + "description": "A list of a product's available selling plan groups. A selling plan group represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "The product's SEO information.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tags", + "description": "A comma separated list of tags that have been added to the product.\nAdditional access scope required for private apps: unauthenticated_read_product_tags.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The product’s title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalInventory", + "description": "The total quantity of inventory in stock for this Product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The date and time when the product was last modified.\nA product's `updatedAt` value can change for different reasons. For example, if an order\nis placed for a product that has inventory tracking set up, then the inventory adjustment\nis counted as an update.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantBySelectedOptions", + "description": "Find a product’s variant based on its selected options.\nThis is useful for converting a user’s selection of product options into a single matching variant.\nIf there is not a variant for the selected options, `null` will be returned.\n", + "args": [ + { + "name": "selectedOptions", + "description": "The input fields used for a selected option.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SelectedOptionInput", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variants", + "description": "List of the product’s variants.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "ofType": null + }, + "defaultValue": "POSITION" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "vendor", + "description": "The product’s vendor name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "OnlineStorePublishable", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Trackable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductCollectionSortKeys", + "description": "The set of valid sort keys for the ProductCollection query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BEST_SELLING", + "description": "Sort by the `best-selling` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED", + "description": "Sort by the `created` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COLLECTION_DEFAULT", + "description": "Sort by the `collection-default` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MANUAL", + "description": "Sort by the `manual` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "Sort by the `price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductConnection", + "description": "An auto-generated type for paginating through multiple Products.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "filters", + "description": "A list of available filters.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Filter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductEdge", + "description": "An auto-generated type which holds one Product and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFilter", + "description": "The input fields for a filter used to view a subset of products in a collection.\nBy default, the `available` and `price` filters are enabled. Filters are customized with the Shopify Search & Discovery app.\nLearn more about [customizing storefront filtering](https://help.shopify.com/manual/online-store/themes/customizing-themes/storefront-filters).\n", + "fields": null, + "inputFields": [ + { + "name": "available", + "description": "Filter on if the product is available for sale.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "A range of prices to filter with-in.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PriceRangeFilter", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productMetafield", + "description": "A product metafield to filter on.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetafieldFilter", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productType", + "description": "The product type to filter on.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productVendor", + "description": "The product vendor to filter on.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "tag", + "description": "A product tag to filter on.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "variantMetafield", + "description": "A variant metafield to filter on.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetafieldFilter", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "variantOption", + "description": "A variant option to filter on.", + "type": { + "kind": "INPUT_OBJECT", + "name": "VariantOptionFilter", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductImageSortKeys", + "description": "The set of valid sort keys for the ProductImage query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductMediaSortKeys", + "description": "The set of valid sort keys for the ProductMedia query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "description": "Product property names like \"Size\", \"Color\", and \"Material\" that the customers can select.\nVariants are selected based on permutations of these options.\n255 characters limit each.\n", + "fields": [ + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product option’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The corresponding value to the product option name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPriceRange", + "description": "The price range of the product.", + "fields": [ + { + "name": "maxVariantPrice", + "description": "The highest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minVariantPrice", + "description": "The lowest variant's price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductRecommendationIntent", + "description": "The recommendation intent that is used to generate product recommendations.\nYou can use intent to generate product recommendations according to different strategies.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RELATED", + "description": "Offer customers a mix of products that are similar or complementary to a product for which recommendations are to be fetched. An example is substitutable products that display in a You may also like section.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPLEMENTARY", + "description": "Offer customers products that are complementary to a product for which recommendations are to be fetched. An example is add-on products that display in a Pair it with section.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductSortKeys", + "description": "The set of valid sort keys for the Product query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BEST_SELLING", + "description": "Sort by the `best_selling` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATED_AT", + "description": "Sort by the `created_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "Sort by the `price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "Sort by the `product_type` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UPDATED_AT", + "description": "Sort by the `updated_at` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VENDOR", + "description": "Sort by the `vendor` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "description": "A product variant represents a different version of a product, such as differing sizes or differing colors.\n", + "fields": [ + { + "name": "availableForSale", + "description": "Indicates if the product variant is available for sale.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "barcode", + "description": "The barcode (for example, ISBN, UPC, or GTIN) associated with the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtPrice", + "description": "The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPrice` is higher than `price`.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "compareAtPriceV2", + "description": "The compare at price of the variant. This can be used to mark a variant as on sale, when `compareAtPriceV2` is higher than `priceV2`.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `compareAtPrice` instead." + }, + { + "name": "currentlyNotInStock", + "description": "Whether a product is out of stock but still available for purchase (used for backorders).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "Image associated with the product variant. This field falls back to the product image if no image is available.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The product variant’s price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceV2", + "description": "The product variant’s price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price` instead." + }, + { + "name": "product", + "description": "The product object that the product variant belongs to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityAvailable", + "description": "The total sellable quantity of the variant for online sales channels.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requiresShipping", + "description": "Whether a customer needs to provide a shipping address when placing an order for the product variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedOptions", + "description": "List of product options applied to the variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlanAllocations", + "description": "Represents an association between a variant and a selling plan. Selling plan allocations describe which selling plans are available for each variant, and what their impact is on pricing.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAllocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The SKU (stock keeping unit) associated with the variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "storeAvailability", + "description": "The in-store pickup availability of this variant by location.", + "args": [ + { + "name": "near", + "description": "Used to sort results based on proximity to the provided location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "GeoCoordinateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StoreAvailabilityConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The product variant’s title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitPrice", + "description": "The unit price value for the variant based on the variant's measurement.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitPriceMeasurement", + "description": "The unit price measurement for the variant.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "UnitPriceMeasurement", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The weight of the product variant in the unit system specified with `weight_unit`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weightUnit", + "description": "Unit of measurement for weight.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "WeightUnit", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantConnection", + "description": "An auto-generated type for paginating through multiple ProductVariants.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariantEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in ProductVariantEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariantEdge", + "description": "An auto-generated type which holds one ProductVariant and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of ProductVariantEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductVariantSortKeys", + "description": "The set of valid sort keys for the ProductVariant query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "Sort by the `id` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POSITION", + "description": "Sort by the `position` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms when the `query` parameter is specified on the connection.\nDon't use this sort key when no search query is specified.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Sort by the `title` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SKU", + "description": "Sort by the `sku` value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QueryRoot", + "description": "The schema’s entry-point for queries. This acts as the public, top-level API from which all queries must start.", + "fields": [ + { + "name": "article", + "description": "Fetch a specific Article by its ID.", + "args": [ + { + "name": "id", + "description": "The ID of the `Article`.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "articles", + "description": "List of the shop's articles.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ArticleSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `author`\n - `blog_title`\n - `created_at`\n - `tag`\n - `tag_not`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ArticleConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "blog", + "description": "Fetch a specific `Blog` by one of its unique attributes.", + "args": [ + { + "name": "id", + "description": "The ID of the `Blog`.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "The handle of the `Blog`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "blogByHandle", + "description": "Find a blog by its handle.", + "args": [ + { + "name": "handle", + "description": "The handle of the blog.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Blog", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `blog` instead." + }, + { + "name": "blogs", + "description": "List of the shop's blogs.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "BlogSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `handle`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BlogConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cart", + "description": "Retrieve a cart by its ID. For more information, refer to\n[Manage a cart with the Storefront API](https://shopify.dev/custom-storefronts/cart/manage).\n", + "args": [ + { + "name": "id", + "description": "The ID of the cart.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cartCompletionAttempt", + "description": "A poll for the status of the cart checkout completion and order creation.\n", + "args": [ + { + "name": "attemptId", + "description": "The ID of the attempt.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "UNION", + "name": "CartCompletionAttemptResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collection", + "description": "Fetch a specific `Collection` by one of its unique attributes.", + "args": [ + { + "name": "handle", + "description": "The handle of the `Collection`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The ID of the `Collection`.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "collectionByHandle", + "description": "Find a collection by its handle.", + "args": [ + { + "name": "handle", + "description": "The handle of the collection.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `collection` instead." + }, + { + "name": "collections", + "description": "List of the shop’s collections.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "CollectionSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `collection_type`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CollectionConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer associated with the given access token. Tokens are obtained by using the\n[`customerAccessTokenCreate` mutation](https://shopify.dev/docs/api/storefront/latest/mutations/customerAccessTokenCreate).\n", + "args": [ + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "localization", + "description": "Returns the localized experiences configured for the shop.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Localization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": "List of the shop's locations that support in-store pickup.\n\nWhen sorting by distance, you must specify a location via the `near` argument.\n\n", + "args": [ + { + "name": "near", + "description": "Used to sort results based on proximity to the provided location.", + "type": { + "kind": "INPUT_OBJECT", + "name": "GeoCoordinateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "LocationSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "LocationConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menu", + "description": "Retrieve a [navigation menu](https://help.shopify.com/manual/online-store/menus-and-links) by its handle.", + "args": [ + { + "name": "handle", + "description": "The navigation menu's handle.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Menu", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobject", + "description": "Fetch a specific Metaobject by one of its unique identifiers.", + "args": [ + { + "name": "id", + "description": "The ID of the metaobject.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "The handle and type of the metaobject.", + "type": { + "kind": "INPUT_OBJECT", + "name": "MetaobjectHandleInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metaobject", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metaobjects", + "description": "All active metaobjects for the shop.", + "args": [ + { + "name": "type", + "description": "The type of metaobject to retrieve.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "The key of a field to sort with. Supports \"id\" and \"updated_at\".", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MetaobjectConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "Returns a specific node by ID.", + "args": [ + { + "name": "id", + "description": "The ID of the Node to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "Returns the list of nodes with the given IDs.", + "args": [ + { + "name": "ids", + "description": "The IDs of the Nodes to return.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page", + "description": "Fetch a specific `Page` by one of its unique attributes.", + "args": [ + { + "name": "id", + "description": "The ID of the `Page`.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "handle", + "description": "The handle of the `Page`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageByHandle", + "description": "Find a page by its handle.", + "args": [ + { + "name": "handle", + "description": "The handle of the page.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `page` instead." + }, + { + "name": "pages", + "description": "List of the shop's pages.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "PageSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `handle`\n - `title`\n - `updated_at`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "predictiveSearch", + "description": "List of the predictive search results.", + "args": [ + { + "name": "limit", + "description": "Limits the number of results based on `limit_scope`. The value can range from 1 to 10, and the default is 10.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "limitScope", + "description": "Decides the distribution of results.", + "type": { + "kind": "ENUM", + "name": "PredictiveSearchLimitScope", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The search query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "searchableFields", + "description": "Specifies the list of resource fields to use for search. The default fields searched on are TITLE, PRODUCT_TYPE, VARIANT_TITLE, and VENDOR. For the best search experience, you should search on the default field set.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SearchableField", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "types", + "description": "The types of resources to search for.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PredictiveSearchType", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "unavailableProducts", + "description": "Specifies how unavailable products are displayed in the search results.", + "type": { + "kind": "ENUM", + "name": "SearchUnavailableProductsType", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PredictiveSearchResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Fetch a specific `Product` by one of its unique attributes.", + "args": [ + { + "name": "handle", + "description": "The handle of the `Product`.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The ID of the `Product`.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productByHandle", + "description": "Find a product by its handle.", + "args": [ + { + "name": "handle", + "description": "A unique string that identifies the product. Handles are automatically\ngenerated based on the product's title, and are always lowercase. Whitespace\nand special characters are replaced with a hyphen: `-`. If there are\nmultiple consecutive whitespace or special characters, then they're replaced\nwith a single hyphen. Whitespace or special characters at the beginning are\nremoved. If a duplicate product title is used, then the handle is\nauto-incremented by one. For example, if you had two products called\n`Potion`, then their handles would be `potion` and `potion-1`. After a\nproduct has been created, changing the product title doesn't update the handle.\n", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use `product` instead." + }, + { + "name": "productRecommendations", + "description": "Find recommended products related to a given `product_id`.\nTo learn more about how recommendations are generated, see\n[*Showing product recommendations on product pages*](https://help.shopify.com/themes/development/recommended-products).\n", + "args": [ + { + "name": "intent", + "description": "The recommendation intent that is used to generate product recommendations. You can use intent to generate product recommendations on various pages across the channels, according to different strategies.", + "type": { + "kind": "ENUM", + "name": "ProductRecommendationIntent", + "ofType": null + }, + "defaultValue": "RELATED" + }, + { + "name": "productId", + "description": "The id of the product.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productTags", + "description": "Tags added to products.\nAdditional access scope required: unauthenticated_read_product_tags.\n", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productTypes", + "description": "List of product types for the shop's products that are published to your app.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "List of the shop’s products.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": "ID" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `available_for_sale`\n - `created_at`\n - `product_type`\n - `tag`\n - `tag_not`\n - `title`\n - `updated_at`\n - `variants.price`\n - `vendor`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "publicApiVersions", + "description": "The list of public Storefront API versions, including supported, release candidate and unstable versions.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ApiVersion", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "search", + "description": "List of the search results.", + "args": [ + { + "name": "prefix", + "description": "Specifies whether to perform a partial word match on the last search term.", + "type": { + "kind": "ENUM", + "name": "SearchPrefixQueryType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "types", + "description": "The types of resources to search for.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SearchType", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "unavailableProducts", + "description": "Specifies how unavailable products are displayed in the search results.", + "type": { + "kind": "ENUM", + "name": "SearchUnavailableProductsType", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": "Sort the underlying list by the given key.", + "type": { + "kind": "ENUM", + "name": "SearchSortKeys", + "ofType": null + }, + "defaultValue": "RELEVANCE" + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "The search query.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productFilters", + "description": "Returns a subset of products matching all product filters.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilter", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultItemConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "The shop associated with the storefront access token.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlRedirects", + "description": "A list of redirects for a shop.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "query", + "description": "Supported filter parameters:\n - `created_at`\n - `path`\n - `target`\n\nSee the detailed [search syntax](https://shopify.dev/api/usage/search-syntax)\nfor more information about using filters.\n", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SEO", + "description": "SEO information.", + "fields": [ + { + "name": "description", + "description": "The meta description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The SEO title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ScriptDiscountApplication", + "description": "Script discount applications capture the intentions of a discount that\nwas created by a Shopify Script.\n", + "fields": [ + { + "name": "allocationMethod", + "description": "The method by which the discount's value is allocated to its entitled items.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationAllocationMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetSelection", + "description": "Which lines of targetType that the discount is allocated over.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetSelection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetType", + "description": "The type of line that the discount is applicable towards.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "DiscountApplicationTargetType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the application as defined by the Script.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the discount application.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "PricingValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DiscountApplication", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchPrefixQueryType", + "description": "Specifies whether to perform a partial word match on the last search term.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "LAST", + "description": "Perform a partial word match on the last search term.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NONE", + "description": "Don't perform a partial word match on the last search term.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchQuerySuggestion", + "description": "A search query suggestion.", + "fields": [ + { + "name": "styledText", + "description": "The text of the search query suggestion with highlighted HTML tags.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The text of the search query suggestion.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Trackable", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SearchResultItem", + "description": "A search result that matches the search query.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SearchResultItemConnection", + "description": "An auto-generated type for paginating through multiple SearchResultItems.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultItemEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SearchResultItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SearchResultItem", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productFilters", + "description": "A list of available filters.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Filter", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": "The total number of results.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchResultItemEdge", + "description": "An auto-generated type which holds one SearchResultItem and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SearchResultItemEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SearchResultItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchSortKeys", + "description": "The set of valid sort keys for the search query.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRICE", + "description": "Sort by the `price` value.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEVANCE", + "description": "Sort by relevance to the search terms.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchType", + "description": "The types of search items to perform search within.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT", + "description": "Returns matching products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAGE", + "description": "Returns matching pages.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARTICLE", + "description": "Returns matching articles.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchUnavailableProductsType", + "description": "Specifies whether to display results for unavailable products.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SHOW", + "description": "Show unavailable products in the order that they're found.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HIDE", + "description": "Exclude unavailable products.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LAST", + "description": "Show unavailable products after all other matching results. This is the default.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SearchableField", + "description": "Specifies the list of resource fields to search.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AUTHOR", + "description": "Author of the page or article.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BODY", + "description": "Body of the page or article or product description or collection description.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT_TYPE", + "description": "Product type.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAG", + "description": "Tag associated with the product or article.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TITLE", + "description": "Title of the page or article or product title or collection title.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANTS_BARCODE", + "description": "Variant barcode.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANTS_SKU", + "description": "Variant SKU.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIANTS_TITLE", + "description": "Variant title.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VENDOR", + "description": "Product vendor.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedOption", + "description": "Properties used by customers to select a product variant.\nProducts can have multiple options, like different sizes or colors.\n", + "fields": [ + { + "name": "name", + "description": "The product option’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The product option’s value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SelectedOptionInput", + "description": "The input fields required for a selected option.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The product option’s name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The product option’s value.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlan", + "description": "Represents how products and variants can be sold and purchased.", + "fields": [ + { + "name": "checkoutCharge", + "description": "The initial payment due for the purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanCheckoutCharge", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The description of the selling plan.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the selling plan. For example, '6 weeks of prepaid granola, delivered weekly'.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "The selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product. Individual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceAdjustments", + "description": "The price adjustments that a selling plan makes when a variant is purchased with a selling plan.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanPriceAdjustment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringDeliveries", + "description": "Whether purchasing the selling plan will result in multiple deliveries.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "description": "Represents an association between a variant and a selling plan. Selling plan allocations describe the options offered for each variant, and the price of the variant when purchased with a selling plan.", + "fields": [ + { + "name": "checkoutChargeAmount", + "description": "The checkout charge amount due for the purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceAdjustments", + "description": "A list of price adjustments, with a maximum of two. When there are two, the first price adjustment goes into effect at the time of purchase, while the second one starts after a certain number of orders. A price adjustment represents how a selling plan affects pricing when a variant is purchased with a selling plan. Prices display in the customer's currency if the shop is configured for it.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAllocationPriceAdjustment", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "remainingBalanceChargeAmount", + "description": "The remaining balance charge amount due for the purchase.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlan", + "description": "A representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanAllocationConnection", + "description": "An auto-generated type for paginating through multiple SellingPlanAllocations.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAllocationEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SellingPlanAllocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanAllocationEdge", + "description": "An auto-generated type which holds one SellingPlanAllocation and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SellingPlanAllocationEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanAllocation", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanAllocationPriceAdjustment", + "description": "The resulting prices for variants when they're purchased with a specific selling plan.", + "fields": [ + { + "name": "compareAtPrice", + "description": "The price of the variant when it's purchased without a selling plan for the same number of deliveries. For example, if a customer purchases 6 deliveries of $10.00 granola separately, then the price is 6 x $10.00 = $60.00.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "perDeliveryPrice", + "description": "The effective price for a single delivery. For example, for a prepaid subscription plan that includes 6 deliveries at the price of $48.00, the per delivery price is $8.00.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the variant when it's purchased with a selling plan For example, for a prepaid subscription plan that includes 6 deliveries of $10.00 granola, where the customer gets 20% off, the price is 6 x $10.00 x 0.80 = $48.00.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitPrice", + "description": "The resulting price per unit for the variant associated with the selling plan. If the variant isn't sold by quantity or measurement, then this field returns `null`.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutCharge", + "description": "The initial payment due for the purchase.", + "fields": [ + { + "name": "type", + "description": "The charge type for the checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SellingPlanCheckoutChargeType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The charge value for the checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanCheckoutChargeValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutChargePercentageValue", + "description": "The percentage value of the price used for checkout charge.", + "fields": [ + { + "name": "percentage", + "description": "The percentage value of the price used for checkout charge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SellingPlanCheckoutChargeType", + "description": "The checkout charge when the full amount isn't charged at checkout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERCENTAGE", + "description": "The checkout charge is a percentage of the product or variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "The checkout charge is a fixed price amount.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanCheckoutChargeValue", + "description": "The portion of the price to be charged at checkout.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanCheckoutChargePercentageValue", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SellingPlanConnection", + "description": "An auto-generated type for paginating through multiple SellingPlans.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SellingPlanEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanEdge", + "description": "An auto-generated type which holds one SellingPlan and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SellingPlanEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedAmountPriceAdjustment", + "description": "A fixed amount that's deducted from the original variant price. For example, $10.00 off.", + "fields": [ + { + "name": "adjustmentAmount", + "description": "The money value of the price adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedPriceAdjustment", + "description": "A fixed price adjustment for a variant that's purchased with a selling plan.", + "fields": [ + { + "name": "price", + "description": "A new price of the variant when it's purchased with the selling plan.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "description": "Represents a selling method. For example, 'Subscribe and save' is a selling method where customers pay for goods or services per delivery. A selling plan group contains individual selling plans.", + "fields": [ + { + "name": "appName", + "description": "A display friendly name for the app that created the selling plan group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the selling plan group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "options", + "description": "Represents the selling plan options available in the drop-down list in the storefront. For example, 'Delivery every week' or 'Delivery every 2 weeks' specifies the delivery frequency options for the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupOption", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellingPlans", + "description": "A list of selling plans in a selling plan group. A selling plan is a representation of how products and variants can be sold and purchased. For example, an individual selling plan could be '6 weeks of prepaid granola, delivered weekly'.", + "args": [ + { + "name": "first", + "description": "Returns up to the first `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "after", + "description": "Returns the elements that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns up to the last `n` elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reverse", + "description": "Reverse the order of the underlying list.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanConnection", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupConnection", + "description": "An auto-generated type for paginating through multiple SellingPlanGroups.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroupEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in SellingPlanGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupEdge", + "description": "An auto-generated type which holds one SellingPlanGroup and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of SellingPlanGroupEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellingPlanGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanGroupOption", + "description": "Represents an option on a selling plan group that's available in the drop-down list in the storefront.\n\nIndividual selling plans contribute their options to the associated selling plan group. For example, a selling plan group might have an option called `option1: Delivery every`. One selling plan in that group could contribute `option1: 2 weeks` with the pricing for that option, and another selling plan could contribute `option1: 4 weeks`, with different pricing.", + "fields": [ + { + "name": "name", + "description": "The name of the option. For example, 'Delivery every'.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The values for the options specified by the selling plans in the selling plan group. For example, '1 week', '2 weeks', '3 weeks'.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanOption", + "description": "An option provided by a Selling Plan.", + "fields": [ + { + "name": "name", + "description": "The name of the option (ie \"Delivery every\").", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the option (ie \"Month\").", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanPercentagePriceAdjustment", + "description": "A percentage amount that's deducted from the original variant price. For example, 10% off.", + "fields": [ + { + "name": "adjustmentPercentage", + "description": "The percentage value of the price adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanPriceAdjustment", + "description": "Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments. If a variant has multiple price adjustments, then the first price adjustment applies when the variant is initially purchased. The second price adjustment applies after a certain number of orders (specified by the `orderCount` field) are made. If a selling plan doesn't have any price adjustments, then the unadjusted price of the variant is the effective price.", + "fields": [ + { + "name": "adjustmentValue", + "description": "The type of price adjustment. An adjustment value can have one of three types: percentage, amount off, or a new price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "UNION", + "name": "SellingPlanPriceAdjustmentValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderCount", + "description": "The number of orders that the price adjustment applies to. If the price adjustment always applies, then this field is `null`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "UNION", + "name": "SellingPlanPriceAdjustmentValue", + "description": "Represents by how much the price of a variant associated with a selling plan is adjusted. Each variant can have up to two price adjustments.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "SellingPlanFixedAmountPriceAdjustment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanFixedPriceAdjustment", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SellingPlanPercentagePriceAdjustment", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "ShippingRate", + "description": "A shipping rate to be applied to a checkout.", + "fields": [ + { + "name": "handle", + "description": "Human-readable unique identifier for this shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "Price of this shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceV2", + "description": "Price of this shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `price` instead." + }, + { + "name": "title", + "description": "Title of this shipping rate.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "description": "Shop represents a collection of the general settings and information about the shop.", + "fields": [ + { + "name": "brand", + "description": "The shop's branding configuration.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Brand", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A description of the shop.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafield", + "description": "Returns a metafield found by namespace and key.", + "args": [ + { + "name": "key", + "description": "The identifier for the metafield.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "namespace", + "description": "The container the metafield belongs to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metafields", + "description": "The metafields associated with the resource matching the supplied list of namespaces and keys.", + "args": [ + { + "name": "identifiers", + "description": "The list of metafields to retrieve by namespace and key.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "HasMetafieldsIdentifier", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metafield", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "moneyFormat", + "description": "A string representing the way currency is formatted when the currency isn’t specified.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The shop’s name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentSettings", + "description": "Settings related to payments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PaymentSettings", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "primaryDomain", + "description": "The primary domain of the shop’s Online Store.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Domain", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "privacyPolicy", + "description": "The shop’s privacy policy.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refundPolicy", + "description": "The shop’s refund policy.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingPolicy", + "description": "The shop’s shipping policy.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipsToCountries", + "description": "Countries that the shop ships to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionPolicy", + "description": "The shop’s subscription policy.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicyWithDefault", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "termsOfService", + "description": "The shop’s terms of service.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShopPolicy", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "HasMetafields", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ShopPayWalletContentInput", + "description": "The input fields for submitting Shop Pay payment method information for checkout.\n", + "fields": null, + "inputFields": [ + { + "name": "billingAddress", + "description": "The customer's billing address.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "sessionToken", + "description": "Session token for transaction.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicy", + "description": "Policy that a merchant has configured for their store, such as their refund or privacy policy.", + "fields": [ + { + "name": "body", + "description": "Policy text, maximum size of 64kb.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "Policy’s handle.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "Policy’s title.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Public URL to the policy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopPolicyWithDefault", + "description": "A policy for the store that comes with a default value, such as a subscription policy.\nIf the merchant hasn't configured a policy for their store, then the policy will return the default value.\nOtherwise, the policy will return the merchant-configured value.\n", + "fields": [ + { + "name": "body", + "description": "The text of the policy. Maximum size: 64KB.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "handle", + "description": "The handle of the policy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique ID of the policy. A default policy doesn't have an ID.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The title of the policy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Public URL to the policy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StoreAvailability", + "description": "The availability of a product variant at a particular location.\nLocal pick-up must be enabled in the store's shipping settings, otherwise this will return an empty result.\n", + "fields": [ + { + "name": "available", + "description": "Whether the product variant is in-stock at this location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "location", + "description": "The location where this product variant is stocked at.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Location", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickUpTime", + "description": "Returns the estimated amount of time it takes for pickup to be ready (Example: Usually ready in 24 hours).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityAvailable", + "description": "The quantity of the product variant in-stock at this location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StoreAvailabilityConnection", + "description": "An auto-generated type for paginating through multiple StoreAvailabilities.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StoreAvailabilityEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in StoreAvailabilityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StoreAvailability", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StoreAvailabilityEdge", + "description": "An auto-generated type which holds one StoreAvailability and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StoreAvailabilityEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StoreAvailability", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "String", + "description": "Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StringConnection", + "description": "An auto-generated type for paginating through a list of Strings.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StringEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "StringEdge", + "description": "An auto-generated type which holds one String and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of StringEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubmissionError", + "description": "An error that occurred during cart submit for completion.", + "fields": [ + { + "name": "code", + "description": "The error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SubmissionErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SubmissionErrorCode", + "description": "The code of the error that occurred during cart submit for completion.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ERROR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NO_DELIVERY_GROUP_SELECTED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUYER_IDENTITY_EMAIL_IS_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUYER_IDENTITY_EMAIL_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUYER_IDENTITY_PHONE_IS_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS1_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS1_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS1_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS2_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS2_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS2_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CITY_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CITY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_CITY_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_COMPANY_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_COMPANY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_COMPANY_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_COUNTRY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_FIRST_NAME_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_FIRST_NAME_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_FIRST_NAME_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_INVALID_POSTAL_CODE_FOR_COUNTRY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_INVALID_POSTAL_CODE_FOR_ZONE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_LAST_NAME_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_LAST_NAME_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_LAST_NAME_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_NO_DELIVERY_AVAILABLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_NO_DELIVERY_AVAILABLE_FOR_MERCHANDISE_LINE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_OPTIONS_PHONE_NUMBER_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_OPTIONS_PHONE_NUMBER_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_PHONE_NUMBER_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_PHONE_NUMBER_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_POSTAL_CODE_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_POSTAL_CODE_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ZONE_NOT_FOUND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ZONE_REQUIRED_FOR_COUNTRY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERY_ADDRESS_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANDISE_NOT_APPLICABLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANDISE_LINE_LIMIT_REACHED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANDISE_NOT_ENOUGH_STOCK_AVAILABLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANDISE_OUT_OF_STOCK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MERCHANDISE_PRODUCT_NOT_PUBLISHED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS1_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS1_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS1_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS2_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS2_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_ADDRESS2_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CITY_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CITY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CITY_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_COMPANY_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_COMPANY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_COMPANY_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_COUNTRY_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_BASE_EXPIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_BASE_GATEWAY_NOT_SUPPORTED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_BASE_INVALID_START_DATE_OR_ISSUE_NUMBER_FOR_DEBIT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_BRAND_NOT_SUPPORTED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_FIRST_NAME_BLANK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_GENERIC", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_LAST_NAME_BLANK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_MONTH_INCLUSION", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_NAME_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_NUMBER_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_NUMBER_INVALID_FORMAT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_SESSION_ID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_BLANK", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_VERIFICATION_VALUE_INVALID_FOR_CARD_TYPE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_YEAR_EXPIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_CREDIT_CARD_YEAR_INVALID_EXPIRY_YEAR", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_FIRST_NAME_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_FIRST_NAME_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_FIRST_NAME_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_INVALID_POSTAL_CODE_FOR_COUNTRY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_INVALID_POSTAL_CODE_FOR_ZONE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_LAST_NAME_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_LAST_NAME_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_LAST_NAME_TOO_LONG", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_METHOD_UNAVAILABLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_METHOD_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_UNACCEPTABLE_PAYMENT_AMOUNT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_PHONE_NUMBER_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_PHONE_NUMBER_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_POSTAL_CODE_INVALID", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_POSTAL_CODE_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_SHOPIFY_PAYMENTS_REQUIRED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_WALLET_CONTENT_MISSING", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_BILLING_ADDRESS_ZONE_NOT_FOUND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PAYMENTS_BILLING_ADDRESS_ZONE_REQUIRED_FOR_COUNTRY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAXES_MUST_BE_DEFINED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAXES_LINE_ID_NOT_FOUND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "TAXES_DELIVERY_GROUP_ID_NOT_FOUND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubmitAlreadyAccepted", + "description": "Cart submit for checkout completion is successful.", + "fields": [ + { + "name": "attemptId", + "description": "The ID of the cart completion attempt that will be used for polling for the result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubmitFailed", + "description": "Cart submit for checkout completion failed.", + "fields": [ + { + "name": "checkoutUrl", + "description": "The URL of the checkout for the cart.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "URL", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "errors", + "description": "The list of errors that occurred from executing the mutation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubmissionError", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubmitSuccess", + "description": "Cart submit for checkout completion is already accepted.", + "fields": [ + { + "name": "attemptId", + "description": "The ID of the cart completion attempt that will be used for polling for the result.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubmitThrottled", + "description": "Cart submit for checkout completion is throttled.", + "fields": [ + { + "name": "pollAfter", + "description": "UTC date time string that indicates the time after which clients should make their next\npoll request. Any poll requests sent before this time will be ignored. Use this value to schedule the\nnext poll request.\n", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "TokenizedPaymentInputV3", + "description": "Specifies the fields required to complete a checkout with\na tokenized payment.\n", + "fields": null, + "inputFields": [ + { + "name": "type", + "description": "The type of payment token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PaymentTokenType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentAmount", + "description": "The amount and currency of the payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MoneyInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "idempotencyKey", + "description": "A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one. For more information, refer to [Idempotent requests](https://shopify.dev/api/usage/idempotent-requests).", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "billingAddress", + "description": "The billing address for the payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "MailingAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "paymentData", + "description": "A simple string or JSON containing the required payment data for the tokenized payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "test", + "description": "Whether to execute the payment in test mode, if possible. Test mode isn't supported in production stores. Defaults to `false`.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + }, + { + "name": "identifier", + "description": "Public Hash Key used for AndroidPay payments only.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Trackable", + "description": "Represents a resource that you can track the origin of the search traffic.", + "fields": [ + { + "name": "trackingParameters", + "description": "A URL parameters to be added to a page URL when it is linked from a GraphQL result. This allows for tracking the origin of the traffic.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Article", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Collection", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Page", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SearchQuerySuggestion", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "Transaction", + "description": "An object representing exchange of money for a product or service.", + "fields": [ + { + "name": "amount", + "description": "The amount of money that the transaction was for.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "amountV2", + "description": "The amount of money that the transaction was for.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MoneyV2", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `amount` instead." + }, + { + "name": "kind", + "description": "The kind of the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TransactionKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status of the transaction.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "TransactionStatus", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `statusV2` instead." + }, + { + "name": "statusV2", + "description": "The status of the transaction.", + "args": [], + "type": { + "kind": "ENUM", + "name": "TransactionStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "test", + "description": "Whether the transaction was done in test mode or not.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TransactionKind", + "description": "The different kinds of order transactions.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SALE", + "description": "An authorization and capture performed together in a single step.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CAPTURE", + "description": "A transfer of the money that was reserved during the authorization stage.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZATION", + "description": "An amount reserved against the cardholder's funding source.\nMoney does not change hands until the authorization is captured.\n", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "EMV_AUTHORIZATION", + "description": "An authorization for a payment taken with an EMV credit card reader.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHANGE", + "description": "Money returned to the customer when they have paid too much.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "TransactionStatus", + "description": "Transaction statuses describe the status of a transaction.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PENDING", + "description": "The transaction is pending.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUCCESS", + "description": "The transaction succeeded.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FAILURE", + "description": "The transaction failed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ERROR", + "description": "There was an error while processing the transaction.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "URL", + "description": "Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and\n[RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.\n\nFor example, `\"https://johns-apparel.myshopify.com\"` is a valid URL. It includes a scheme (`https`) and a host\n(`johns-apparel.myshopify.com`).\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UnitPriceMeasurement", + "description": "The measurement used to calculate a unit price for a product variant (e.g. $9.99 / 100ml).\n", + "fields": [ + { + "name": "measuredType", + "description": "The type of unit of measurement for the unit price measurement.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UnitPriceMeasurementMeasuredType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityUnit", + "description": "The quantity unit for the unit price measurement.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UnitPriceMeasurementMeasuredUnit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityValue", + "description": "The quantity value for the unit price measurement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referenceUnit", + "description": "The reference unit for the unit price measurement.", + "args": [], + "type": { + "kind": "ENUM", + "name": "UnitPriceMeasurementMeasuredUnit", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referenceValue", + "description": "The reference value for the unit price measurement.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UnitPriceMeasurementMeasuredType", + "description": "The accepted types of unit of measurement.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VOLUME", + "description": "Unit of measurements representing volumes.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "WEIGHT", + "description": "Unit of measurements representing weights.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LENGTH", + "description": "Unit of measurements representing lengths.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AREA", + "description": "Unit of measurements representing areas.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UnitPriceMeasurementMeasuredUnit", + "description": "The valid units of measurement for a unit price measurement.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ML", + "description": "1000 milliliters equals 1 liter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CL", + "description": "100 centiliters equals 1 liter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "L", + "description": "Metric system unit of volume.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "M3", + "description": "1 cubic meter equals 1000 liters.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MG", + "description": "1000 milligrams equals 1 gram.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "G", + "description": "Metric system unit of weight.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "KG", + "description": "1 kilogram equals 1000 grams.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MM", + "description": "1000 millimeters equals 1 meter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CM", + "description": "100 centimeters equals 1 meter.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "M", + "description": "Metric system unit of length.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "M2", + "description": "Metric system unit of area.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UnitSystem", + "description": "Systems of weights and measures.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "IMPERIAL_SYSTEM", + "description": "Imperial system of weights and measures.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "METRIC_SYSTEM", + "description": "Metric system of weights and measures.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "UnsignedInt64", + "description": "An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits.\n\nExample value: `\"50\"`.\n", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirect", + "description": "A redirect on the online store.", + "fields": [ + { + "name": "id", + "description": "The ID of the URL redirect.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "path", + "description": "The old path to be redirected from. When the user visits this path, they'll be redirected to the target location.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "target", + "description": "The target location where the user will be redirected to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectConnection", + "description": "An auto-generated type for paginating through multiple UrlRedirects.\n", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirectEdge", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A list of the nodes contained in UrlRedirectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UrlRedirectEdge", + "description": "An auto-generated type which holds one UrlRedirect and a cursor during pagination.\n", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of UrlRedirectEdge.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "UrlRedirect", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UserError", + "description": "Represents an error in the input of a mutation.", + "fields": [ + { + "name": "field", + "description": "The path to the input field that caused the error.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The error message.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "DisplayableError", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "VariantOptionFilter", + "description": "The input fields for a filter used to view a subset of products in a collection matching a specific variant option.", + "fields": null, + "inputFields": [ + { + "name": "name", + "description": "The name of the variant option to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The value of the variant option to filter on.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Video", + "description": "Represents a Shopify hosted video.", + "fields": [ + { + "name": "alt", + "description": "A word or phrase to share the nature or contents of a media.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "A globally-unique ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mediaContentType", + "description": "The media content type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "MediaContentType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "presentation", + "description": "The presentation for a media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "MediaPresentation", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "previewImage", + "description": "The preview image for the media.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sources", + "description": "The sources for a video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "VideoSource", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Media", + "ofType": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "VideoSource", + "description": "Represents a source for a Shopify hosted video.", + "fields": [ + { + "name": "format", + "description": "The format of the video source.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The height of the video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mimeType", + "description": "The video MIME type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL of the video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The width of the video.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "WeightUnit", + "description": "Units of measurement for weight.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "KILOGRAMS", + "description": "1 kilogram equals 1000 grams.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "GRAMS", + "description": "Metric system unit of mass.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "POUNDS", + "description": "1 pound equals 16 ounces.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUNCES", + "description": "Imperial system unit of mass.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Directive", + "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL's execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", + "fields": [ + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRepeatable", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__DirectiveLocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onField", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + }, + { + "name": "onFragment", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + }, + { + "name": "onOperation", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use `locations`." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__DirectiveLocation", + "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUERY", + "description": "Location adjacent to a query operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUTATION", + "description": "Location adjacent to a mutation operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION", + "description": "Location adjacent to a subscription operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD", + "description": "Location adjacent to a field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_DEFINITION", + "description": "Location adjacent to a fragment definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_SPREAD", + "description": "Location adjacent to a fragment spread.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INLINE_FRAGMENT", + "description": "Location adjacent to an inline fragment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEMA", + "description": "Location adjacent to a schema definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCALAR", + "description": "Location adjacent to a scalar definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Location adjacent to an object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD_DEFINITION", + "description": "Location adjacent to a field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARGUMENT_DEFINITION", + "description": "Location adjacent to an argument definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Location adjacent to an interface definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Location adjacent to a union definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Location adjacent to an enum definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM_VALUE", + "description": "Location adjacent to an enum value definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Location adjacent to an input object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_FIELD_DEFINITION", + "description": "Location adjacent to an input object field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIABLE_DEFINITION", + "description": "Location adjacent to a variable definition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__EnumValue", + "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", + "fields": [ + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Field", + "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", + "fields": [ + { + "name": "args", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__InputValue", + "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", + "fields": [ + { + "name": "defaultValue", + "description": "A GraphQL-formatted string representing the default value for this input value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Schema", + "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "directives", + "description": "A list of all directives supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Directive", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mutationType", + "description": "If this server supports mutation, the type that mutation operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryType", + "description": "The type that query operations will be rooted at.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionType", + "description": "If this server support subscription, the type that subscription operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "A list of all types supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Type", + "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the `__TypeKind` enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enumValues", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__EnumValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Field", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inputFields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interfaces", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isOneOf", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__TypeKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ofType", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "possibleTypes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "specifiedByURL", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__TypeKind", + "description": "An enum describing what kind of type a given `__Type` is.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SCALAR", + "description": "Indicates this type is a scalar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Indicates this type is an object. `fields` and `interfaces` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Indicates this type is an interface. `fields` and `possibleTypes` are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Indicates this type is a union. `possibleTypes` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Indicates this type is an enum. `enumValues` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Indicates this type is an input object. `inputFields` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST", + "description": "Indicates this type is a list. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_NULL", + "description": "Indicates this type is a non-null. `ofType` is a valid field.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + } + ], + "directives": [ + { + "name": "include", + "description": "Directs the executor to include this field or fragment only when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Included when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "skip", + "description": "Directs the executor to skip this field or fragment when the `if` argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Skipped when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "deprecated", + "description": "Marks an element of a GraphQL schema as no longer supported.", + "locations": [ + "FIELD_DEFINITION", + "ENUM_VALUE", + "ARGUMENT_DEFINITION", + "INPUT_FIELD_DEFINITION" + ], + "args": [ + { + "name": "reason", + "description": "Explains why this element was deprecated, usually also including a suggestion for how to access supported similar data. Formatted in [Markdown](https://daringfireball.net/projects/markdown/).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\"No longer supported\"" + } + ] + }, + { + "name": "oneOf", + "description": "Requires that exactly one field must be supplied and that field must not be `null`.", + "locations": [ + "INPUT_OBJECT" + ], + "args": [] + }, + { + "name": "accessRestricted", + "description": "Marks an element of a GraphQL schema as having restricted access.", + "locations": [ + "FIELD_DEFINITION", + "OBJECT" + ], + "args": [ + { + "name": "reason", + "description": "Explains the reason around this restriction", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "null" + } + ] + }, + { + "name": "inContext", + "description": "Contextualizes data based on the additional information provided by the\ndirective. For example, you can use the `@inContext(country: CA)` directive to\n[query a product's price](https://shopify.dev/custom-storefronts/internationalization/international-pricing)\nin a storefront within the context of Canada.\n", + "locations": [ + "QUERY", + "MUTATION" + ], + "args": [ + { + "name": "country", + "description": "The country code for context. For example, `CA`.", + "type": { + "kind": "ENUM", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "language", + "description": "The language code for context. For example, `EN`.", + "type": { + "kind": "ENUM", + "name": "LanguageCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "preferredLocationId", + "description": "The identifier of the customer's preferred location.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/shopify/utils/transform.ts b/shopify/utils/transform.ts index 4be44024c..eaef491b8 100644 --- a/shopify/utils/transform.ts +++ b/shopify/utils/transform.ts @@ -5,16 +5,11 @@ import type { PropertyValue, UnitPriceSpecification, } from "../../commerce/types.ts"; +import { DEFAULT_IMAGE } from "../../commerce/utils/constants.ts"; import { Fragment as ProductShopify } from "./fragments/product.ts"; import { Fragment as SkuShopify } from "./fragments/productVariant.ts"; import { SelectedOption as SelectedOptionShopify } from "./types.ts"; -const DEFAULT_IMAGE = { - altText: "image", - url: - "https://storecomponents.vtexassets.com/assets/faststore/images/image___117a6d3e229a96ad0e0d0876352566e2.svg", -}; - const getPath = ({ handle }: ProductShopify, sku?: SkuShopify) => sku ? `/products/${handle}-${getIdFromVariantId(sku.id)}` @@ -98,7 +93,7 @@ export const toProduct = ( } = sku; const additionalProperty = selectedOptions.map(toPropertyValue); - const skuImages = nonEmptyArray([image]) ?? [DEFAULT_IMAGE]; + const skuImages = nonEmptyArray([image]); const hasVariant = level < 1 && variants.nodes.map((variant) => toProduct(product, variant, url, 1)); const priceSpec: UnitPriceSpecification[] = [{ @@ -139,11 +134,11 @@ export const toProduct = ( url: img.url, })), }, - image: skuImages.map((img) => ({ + image: skuImages?.map((img) => ({ "@type": "ImageObject", alternateName: img.altText ?? "", url: img.url, - })), + })) ?? [DEFAULT_IMAGE], offers: { "@type": "AggregateOffer", priceCurrency: price.currencyCode, diff --git a/utils/graphql.ts b/utils/graphql.ts index 7e5d255e8..b5f888042 100644 --- a/utils/graphql.ts +++ b/utils/graphql.ts @@ -40,8 +40,9 @@ export const createGraphqlClient = ( return { query: async ( - { query = "", variables, operationName }: { + { query = "", fragments = [], variables, operationName }: { query: string; + fragments?: string[]; variables?: V; operationName?: string; }, @@ -49,7 +50,11 @@ export const createGraphqlClient = ( ): Promise => { const { data, errors } = await http[key as any]({}, { ...init, - body: { query, variables: variables as any, operationName }, + body: { + query: [query, ...fragments].join("\n"), + variables: variables as any, + operationName, + }, }).then((res) => res.json()); if (Array.isArray(errors) && errors.length > 0) { diff --git a/utils/http.ts b/utils/http.ts index ad069967e..c74a67303 100644 --- a/utils/http.ts +++ b/utils/http.ts @@ -121,6 +121,8 @@ export const createHttpClient = ({ const url = new URL(compiled, base); mapped.forEach((value, key) => { + if (value === undefined) return; + const arrayed = Array.isArray(value) ? value : [value]; arrayed.forEach((item) => url.searchParams.append(key, `${item}`)); }); diff --git a/vtex/utils/transform.ts b/vtex/utils/transform.ts index dabeffbf7..f37ba6647 100644 --- a/vtex/utils/transform.ts +++ b/vtex/utils/transform.ts @@ -10,6 +10,7 @@ import type { PropertyValue, UnitPriceSpecification, } from "../../commerce/types.ts"; +import { DEFAULT_IMAGE } from "../../commerce/utils/constants.ts"; import { formatRange } from "../../commerce/utils/filters.ts"; import { slugify } from "./slugify.ts"; import type { @@ -59,13 +60,6 @@ const getProductURL = ( const nonEmptyArray = (array: T[] | null | undefined) => Array.isArray(array) && array.length > 0 ? array : null; -const DEFAULT_IMAGE = { - imageLabel: null, - imageText: "image", - imageUrl: - "https://storecomponents.vtexassets.com/assets/faststore/images/image___117a6d3e229a96ad0e0d0876352566e2.svg", -}; - interface ProductOptions { baseUrl: string; /** Price coded currency, e.g.: USD, BRL */ @@ -271,7 +265,7 @@ export const toProduct =

( const referenceIdAdditionalProperty = toAdditionalPropertyReferenceId( referenceId, ); - const images = nonEmptyArray(sku.images) ?? [DEFAULT_IMAGE]; + const images = nonEmptyArray(sku.images); const offers = (sku.sellers ?? []).map( isLegacyProduct(product) ? toOfferLegacy : toOffer, ).sort(bestOfferFirst); @@ -325,12 +319,12 @@ export const toProduct =

( releaseDate, additionalProperty, isVariantOf, - image: images.map(({ imageUrl, imageText, imageLabel }) => { + image: images?.map(({ imageUrl, imageText, imageLabel }) => { const url = imagesByKey.get(getImageKey(imageUrl)) ?? imageUrl; const alternateName = imageText || imageLabel || ""; return { "@type": "ImageObject" as const, alternateName, url }; - }), + }) ?? [DEFAULT_IMAGE], offers: offers.length > 0 ? { "@type": "AggregateOffer", diff --git a/wake/actions/cart/addCoupon.ts b/wake/actions/cart/addCoupon.ts new file mode 100644 index 000000000..d330a0703 --- /dev/null +++ b/wake/actions/cart/addCoupon.ts @@ -0,0 +1,48 @@ +import { gql } from "../../../utils/graphql.ts"; +import { HttpError } from "../../../utils/http.ts"; +import { AppContext } from "../../mod.ts"; +import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; +import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { + AddCouponMutation, + AddCouponMutationVariables, + CheckoutFragment, +} from "../../utils/graphql/graphql.gen.ts"; + +export interface Props { + coupon: string; +} + +const action = async ( + props: Props, + req: Request, + ctx: AppContext, +): Promise> => { + const { storefront } = ctx; + const cartId = getCartCookie(req.headers); + + if (!cartId) { + throw new HttpError(400, "Missing cart cookie"); + } + + const data = await storefront.query< + AddCouponMutation, + AddCouponMutationVariables + >({ + variables: { checkoutId: cartId, ...props }, + fragments: [fragment], + query: gql`mutation AddCoupon($checkoutId: Uuid!, $coupon: String!) { + checkout: checkoutAddCoupon( + checkoutId: $checkoutId + coupon: $coupon + ) { ...Checkout } + }`, + }); + + const checkoutId = data.checkout?.checkoutId; + setCartCookie(ctx.response.headers, checkoutId); + + return data.checkout ?? {}; +}; + +export default action; diff --git a/wake/actions/cart/addItem.ts b/wake/actions/cart/addItem.ts new file mode 100644 index 000000000..ca7a0bf7d --- /dev/null +++ b/wake/actions/cart/addItem.ts @@ -0,0 +1,47 @@ +import { gql } from "../../../utils/graphql.ts"; +import { HttpError } from "../../../utils/http.ts"; +import { AppContext } from "../../mod.ts"; +import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; +import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { + AddItemToCartMutation, + AddItemToCartMutationVariables, + CheckoutFragment, +} from "../../utils/graphql/graphql.gen.ts"; + +export interface Props { + productVariantId: number; + quantity: number; + customization: { customizationId: number; value: string }[]; + subscription: { subscriptionGroupId: number; recurringTypeId: number }; +} + +const action = async ( + props: Props, + req: Request, + ctx: AppContext, +): Promise> => { + const { storefront } = ctx; + const cartId = getCartCookie(req.headers); + + if (!cartId) { + throw new HttpError(400, "Missing cart cookie"); + } + + const data = await storefront.query< + AddItemToCartMutation, + AddItemToCartMutationVariables + >({ + variables: { input: { id: cartId, products: [props] } }, + fragments: [fragment], + query: + gql`mutation AddItemToCart($input: CheckoutProductInput!) { checkout: checkoutAddProduct(input: $input) { ...Checkout }}`, + }); + + const checkoutId = data.checkout?.checkoutId; + setCartCookie(ctx.response.headers, checkoutId); + + return data.checkout ?? {}; +}; + +export default action; diff --git a/wake/actions/cart/removeCoupon.ts b/wake/actions/cart/removeCoupon.ts new file mode 100644 index 000000000..e9bd4d93c --- /dev/null +++ b/wake/actions/cart/removeCoupon.ts @@ -0,0 +1,43 @@ +import { gql } from "../../../utils/graphql.ts"; +import { HttpError } from "../../../utils/http.ts"; +import { AppContext } from "../../mod.ts"; +import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; +import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { + CheckoutFragment, + RemoveCouponMutation, + RemoveCouponMutationVariables, +} from "../../utils/graphql/graphql.gen.ts"; + +const action = async ( + _props: unknown, + req: Request, + ctx: AppContext, +): Promise> => { + const { storefront } = ctx; + const cartId = getCartCookie(req.headers); + + if (!cartId) { + throw new HttpError(400, "Missing cart cookie"); + } + + const data = await storefront.query< + RemoveCouponMutation, + RemoveCouponMutationVariables + >({ + variables: { checkoutId: cartId }, + fragments: [fragment], + query: gql`mutation RemoveCoupon($checkoutId: Uuid!) { + checkout: checkoutRemoveCoupon(checkoutId: $checkoutId) { + ...Checkout + } + }`, + }); + + const checkoutId = data.checkout?.checkoutId; + setCartCookie(ctx.response.headers, checkoutId); + + return data.checkout ?? {}; +}; + +export default action; diff --git a/wake/actions/cart/updateItemQuantity.ts b/wake/actions/cart/updateItemQuantity.ts new file mode 100644 index 000000000..d8efa736d --- /dev/null +++ b/wake/actions/cart/updateItemQuantity.ts @@ -0,0 +1,78 @@ +import { gql } from "../../../utils/graphql.ts"; +import { HttpError } from "../../../utils/http.ts"; +import { AppContext } from "../../mod.ts"; +import { getCartCookie, setCartCookie } from "../../utils/cart.ts"; +import { fragment } from "../../utils/graphql/fragments/checkout.ts"; +import { + AddItemToCartMutation, + AddItemToCartMutationVariables, + CheckoutFragment, + RemoveItemFromCartMutation, + RemoveItemFromCartMutationVariables, +} from "../../utils/graphql/graphql.gen.ts"; + +export interface Props { + productVariantId: number; + quantity: number; + customization: { customizationId: number; value: string }[]; + subscription: { subscriptionGroupId: number; recurringTypeId: number }; +} + +const addToCart = ( + props: Props, + cartId: string, + ctx: AppContext, +) => + ctx.storefront.query< + AddItemToCartMutation, + AddItemToCartMutationVariables + >({ + variables: { + input: { id: cartId, products: [props] }, + }, + fragments: [fragment], + query: + gql`mutation AddItemToCart($input: CheckoutProductInput!) { checkout: checkoutAddProduct(input: $input) { ...Checkout }}`, + }); + +const removeFromCart = ( + props: Props, + cartId: string, + ctx: AppContext, +) => + ctx.storefront.query< + RemoveItemFromCartMutation, + RemoveItemFromCartMutationVariables + >({ + variables: { + input: { id: cartId, products: [{ ...props, quantity: 1e6 }] }, + }, + fragments: [fragment], + query: + gql`mutation RemoveItemFromCart($input: CheckoutProductInput!) { checkout: checkoutRemoveProduct(input: $input) { ...Checkout }}`, + }); + +const action = async ( + props: Props, + req: Request, + ctx: AppContext, +): Promise> => { + const cartId = getCartCookie(req.headers); + + if (!cartId) { + throw new HttpError(400, "Missing cart cookie"); + } + + let data = await removeFromCart(props, cartId, ctx); + + if (props.quantity > 0) { + data = await addToCart(props, cartId, ctx); + } + + const checkoutId = data.checkout?.checkoutId; + setCartCookie(ctx.response.headers, checkoutId); + + return data.checkout ?? {}; +}; + +export default action; diff --git a/wake/hooks/context.ts b/wake/hooks/context.ts new file mode 100644 index 000000000..4f7248ff9 --- /dev/null +++ b/wake/hooks/context.ts @@ -0,0 +1,67 @@ +import { IS_BROWSER } from "$fresh/runtime.ts"; +import { signal } from "@preact/signals"; +import { invoke } from "../runtime.ts"; +import type { CheckoutFragment } from "../utils/graphql/graphql.gen.ts"; + +export interface Context { + cart: Partial; +} + +const loading = signal(true); +const context = { + cart: signal>({}), +}; + +let queue = Promise.resolve(); +let abort = () => {}; +const enqueue = ( + cb: (signal: AbortSignal) => Promise> | Partial, +) => { + abort(); + + loading.value = true; + const controller = new AbortController(); + + queue = queue.then(async () => { + try { + const { cart } = await cb(controller.signal); + + if (controller.signal.aborted) { + throw { name: "AbortError" }; + } + + context.cart.value = { ...context.cart.value, ...cart }; + + loading.value = false; + } catch (error) { + if (error.name === "AbortError") return; + + console.error(error); + loading.value = false; + } + }); + + abort = () => controller.abort(); + + return queue; +}; + +const load = (signal: AbortSignal) => + invoke({ + cart: invoke.wake.loaders.cart(), + }, { signal }); + +if (IS_BROWSER) { + enqueue(load); + + document.addEventListener( + "visibilitychange", + () => document.visibilityState === "visible" && enqueue(load), + ); +} + +export const state = { + ...context, + loading, + enqueue, +}; diff --git a/wake/hooks/useCart.ts b/wake/hooks/useCart.ts new file mode 100644 index 000000000..3016a2629 --- /dev/null +++ b/wake/hooks/useCart.ts @@ -0,0 +1,49 @@ +import type { AnalyticsItem } from "../../commerce/types.ts"; +import type { Manifest } from "../manifest.gen.ts"; +import { invoke } from "../runtime.ts"; +import { CheckoutFragment } from "../utils/graphql/graphql.gen.ts"; +import { Context, state as storeState } from "./context.ts"; + +const { cart, loading } = storeState; + +export const itemToAnalyticsItem = ( + item: NonNullable[number]> & { + coupon?: string; + }, + index: number, +): AnalyticsItem => ({ + item_id: `${item.productId}_${item.productVariantId}`, + item_name: item.name!, + discount: item.price - item.ajustedPrice, + item_variant: item.productVariantId, + // TODO: check + price: item.price, + coupon: item.coupon, + item_brand: item.brand!, + index, + quantity: item.quantity, +}); + +type EnqueuableActions< + K extends keyof Manifest["actions"], +> = Manifest["actions"][K]["default"] extends + (...args: any[]) => Promise ? K : never; + +const enqueue = < + K extends keyof Manifest["actions"], +>(key: EnqueuableActions) => +(props: Parameters[0]) => + storeState.enqueue((signal) => + invoke({ cart: { key, props } } as any, { signal }) as any + ); + +const state = { + cart, + loading, + addItem: enqueue("wake/actions/cart/addItem.ts"), + updateItem: enqueue("wake/actions/cart/updateItemQuantity.ts"), + addCoupon: enqueue("wake/actions/cart/addCoupon.ts"), + removeCoupon: enqueue("wake/actions/cart/removeCoupon.ts"), +}; + +export const useCart = () => state; diff --git a/wake/loaders/cart.ts b/wake/loaders/cart.ts new file mode 100644 index 000000000..30610f39e --- /dev/null +++ b/wake/loaders/cart.ts @@ -0,0 +1,44 @@ +import { gql } from "../../utils/graphql.ts"; +import { AppContext } from "../mod.ts"; +import { getCartCookie, setCartCookie } from "../utils/cart.ts"; +import { fragment } from "../utils/graphql/fragments/checkout.ts"; +import { + CheckoutFragment, + CreateCartMutation, + CreateCartMutationVariables, + GetCartQuery, + GetCartQueryVariables, +} from "../utils/graphql/graphql.gen.ts"; + +/** + * @title VNDA Integration + * @description Cart loader + */ +const loader = async ( + _props: unknown, + req: Request, + ctx: AppContext, +): Promise> => { + const { storefront } = ctx; + const cartId = getCartCookie(req.headers); + + const data = cartId + ? await storefront.query({ + variables: { checkoutId: cartId }, + fragments: [fragment], + query: + gql`query GetCart($checkoutId: String!) { checkout(checkoutId: $checkoutId) { ...Checkout } }`, + }) + : await storefront.query({ + fragments: [fragment], + query: + gql`mutation CreateCart { checkout: createCheckout { ...Checkout } }`, + }); + + const checkoutId = data.checkout?.checkoutId; + setCartCookie(ctx.response.headers, checkoutId); + + return data.checkout ?? {}; +}; + +export default loader; diff --git a/wake/loaders/productDetailsPage.ts b/wake/loaders/productDetailsPage.ts new file mode 100644 index 000000000..cf8365882 --- /dev/null +++ b/wake/loaders/productDetailsPage.ts @@ -0,0 +1,69 @@ +import type { ProductDetailsPage } from "../../commerce/types.ts"; +import { gql } from "../../utils/graphql.ts"; +import type { RequestURLParam } from "../../website/functions/requestToParam.ts"; +import { AppContext } from "../mod.ts"; +import { + GetProductQuery, + GetProductQueryVariables, +} from "../utils/graphql/graphql.gen.ts"; +import { parseSlug, toBreadcrumbList, toProduct } from "../utils/transform.ts"; +import { fragment } from "../utils/graphql/fragments/singleProduct.ts"; + +export interface Props { + slug: RequestURLParam; +} + +/** + * @title Wake Integration + * @description Product Details Page loader + */ +async function loader( + props: Props, + req: Request, + ctx: AppContext, +): Promise { + const url = new URL(req.url); + const { slug } = props; + const { storefront } = ctx; + + if (!slug) return null; + + // const variantId = Number(url.searchParams.get("skuId")) || null; + const { id: productId } = parseSlug(slug); + + if (!productId) { + throw new Error("Missing product id"); + } + + const { product: wakeProduct } = await storefront.query< + GetProductQuery, + GetProductQueryVariables + >({ + fragments: [fragment], + query: + gql`query GetProduct($productId: Long!) { product(productId: $productId) { ...SingleProduct } }`, + variables: { productId }, + }); + + if (!wakeProduct) { + return null; + } + + const product = toProduct(wakeProduct, { base: url }); + + return { + "@type": "ProductDetailsPage", + breadcrumbList: toBreadcrumbList(product, wakeProduct.productCategories, { + base: url, + }), + product, + seo: { + canonical: product.isVariantOf?.url ?? "", + title: wakeProduct.productName ?? "", + description: + wakeProduct.seo?.find((m) => m?.name === "description")?.content ?? "", + }, + }; +} + +export default loader; diff --git a/wake/loaders/productList.ts b/wake/loaders/productList.ts new file mode 100644 index 000000000..3efcdf7fe --- /dev/null +++ b/wake/loaders/productList.ts @@ -0,0 +1,122 @@ +import type { Product } from "../../commerce/types.ts"; +import { gql } from "../../utils/graphql.ts"; +import type { AppContext } from "../mod.ts"; +import { fragment } from "../utils/graphql/fragments/product.ts"; +import { + GetProductsQuery, + GetProductsQueryVariables, + ProductFragment, +} from "../utils/graphql/graphql.gen.ts"; +import { toProduct } from "../utils/transform.ts"; + +export interface Props { + /** + * @title Count + * @description Number of products to return + */ + first: number; + sortDirection: "ASC" | "DESC"; + sortKey: + | "DISCOUNT" + | "NAME" + | "PRICE" + | "RANDOM" + | "RELEASE_DATE" + | "SALES" + | "STOCK"; + filters: { + /** @description The set of attributes to filter. */ + attributes?: { + id?: string[]; + name?: string[]; + type?: string[]; + value?: string[]; + }; + /** @description Choose if you want to retrieve only the available products in stock. */ + available?: boolean; + /** @description The set of brand IDs which the result item brand ID must be included in. */ + brandId?: string[]; + /** @description The set of category IDs which the result item category ID must be included in. */ + categoryId?: string[]; + /** @description The set of EANs which the result item EAN must be included. */ + ean?: string[]; + /** @description Retrieve the product variant only if it contains images. */ + hasImages?: boolean; + /** @description Retrieve the product variant only if it is the main product variant. */ + mainVariant?: boolean; + /** @description The set of prices to filter. */ + prices?: { + /** @description The product discount must be greater than or equal to. */ + discount_gte?: number; + /** @description The product discount must be lesser than or equal to. */ + discount_lte?: number; + /** @description Return only products where the listed price is more than the price. */ + discounted?: boolean; + /** @description The product price must be greater than or equal to. */ + price_gte?: number; + /** @description The product price must be lesser than or equal to. */ + price_lte?: number; + }; + /** @description The product unique identifier (you may provide a list of IDs if needed). */ + productId?: number[]; + /** @description The product variant unique identifier (you may provide a list of IDs if needed). */ + productVariantId?: number[]; + /** @description A product ID or a list of IDs to search for other products with the same parent ID. */ + sameParentAs?: number[]; + /** @description The set of SKUs which the result item SKU must be included. */ + sku?: string[]; + /** @description Show products with a quantity of available products in stock greater than or equal to the given number. */ + stock_gte?: number; + /** @description Show products with a quantity of available products in stock less than or equal to the given number. */ + stock_lte?: number; + /** @description The set of stocks to filter. */ + stocks?: { + dcId?: number[]; + /** @description The distribution center names to match. */ + dcName?: string[]; + /** @description The product stock must be greater than or equal to. */ + stock_gte?: number; + /** @description The product stock must be lesser than or equal to. */ + stock_lte?: number; + }; + /** @description Retrieve products which the last update date is greater than or equal to the given date. */ + updatedAt_gte?: string; + /** @description Retrieve products which the last update date is less than or equal to the given date. */ + updatedAt_lte?: string; + }; +} + +/** + * @title Wake Integration + * @description Product List loader + */ +const productListLoader = async ( + props: Props, + req: Request, + ctx: AppContext, +): Promise => { + const url = new URL(req.url); + const { storefront } = ctx; + + const data = await storefront.query< + GetProductsQuery, + GetProductsQueryVariables + >({ + variables: props, + fragments: [fragment], + query: + gql`query GetProducts($filters: ProductExplicitFiltersInput!, $first: Int!, $sortDirection: SortDirection!, $sortKey: ProductSortKeys) { products(filters: $filters, first: $first, sortDirection: $sortDirection, sortKey: $sortKey) { nodes { ...Product } }}`, + }); + + const products = data.products?.nodes; + + if (!Array.isArray(products)) { + return null; + } + + return products + .filter((node): node is ProductFragment => Boolean(node)) + .map((node) => toProduct(node, { base: url })); +}; + +export default productListLoader; diff --git a/wake/loaders/productListingPage.ts b/wake/loaders/productListingPage.ts new file mode 100644 index 000000000..22a3d5c74 --- /dev/null +++ b/wake/loaders/productListingPage.ts @@ -0,0 +1,164 @@ +import type { ProductListingPage } from "../../commerce/types.ts"; +import { SortOption } from "../../commerce/types.ts"; +import { gql } from "../../utils/graphql.ts"; +import type { AppContext } from "../mod.ts"; +import { fragment } from "../utils/graphql/fragments/product.ts"; +import { + ProductFragment, + ProductSortKeys, + SearchQuery, + SearchQueryVariables, + SortDirection, +} from "../utils/graphql/graphql.gen.ts"; +import { FILTER_PARAM, toFilters, toProduct } from "../utils/transform.ts"; + +export const SORT_OPTIONS: SortOption[] = [ + { value: "ASC:NAME", label: "Nome A-Z" }, + { value: "DESC:NAME", label: "Nome Z-A" }, + { value: "DESC:RELEASE_DATE", label: "Lançamentos" }, + { value: "ASC:PRICE", label: "Menores Preços" }, + { value: "DESC:PRICE", label: "Maiores Preços" }, + { value: "DESC:DISCOUNT", label: "Maiores Descontos" }, + { value: "DESC:SALES", label: "Mais Vendidos" }, +]; + +type SortValue = `${SortDirection}:${ProductSortKeys}`; + +export interface Props { + /** + * @title Count + * @description Number of products to display + */ + first?: number; + + /** @description Types of operations to perform between query terms */ + operation?: "AND" | "OR"; +} + +const filtersFromParams = (searchParams: URLSearchParams) => { + const mapped = searchParams.getAll(FILTER_PARAM) + .reduce((acc, value) => { + const [field, val] = value.split(":"); + if (!acc.has(field)) acc.set(field, []); + acc.get(field)?.push(val); + return acc; + }, new Map()); + + const filters: Array<{ field: string; values: string[] }> = []; + for (const [field, values] of mapped.entries()) { + filters.push({ field, values }); + } + + return filters; +}; + +/** + * @title Wake Integration + * @description Product Listing Page loader + */ +const searchLoader = async ( + props: Props, + req: Request, + ctx: AppContext, +): Promise => { + // get url from params + const url = new URL(req.url); + const { storefront } = ctx; + + const first = props.first ?? 12; + const filters = filtersFromParams(url.searchParams); + const sort = url.searchParams.get("sort") as SortValue | null ?? + "DESC:SALES"; + const page = Number(url.searchParams.get("page")) || 0; + const query = url.searchParams.get("busca"); + const operation = props.operation ?? "AND"; + const [sortDirection, sortKey] = sort.split(":") as [ + SortDirection, + ProductSortKeys, + ]; + + const data = await storefront.query({ + variables: { query, operation, first, sortDirection, sortKey, filters }, + fragments: [fragment], + query: + gql`query Search($operation: Operation!, $query: String, $first: Int!, $sortDirection: SortDirection, $sortKey: ProductSearchSortKeys, $filters: [ProductFilterInput]) { + search(query: $query, operation: $operation) { + aggregations { + filters { + field + origin + values { + quantity + name + } + } + } + breadcrumbs { + link + text + } + forbiddenTerm { + text + suggested + } + pageSize + redirectUrl + searchTime + products(first: $first, sortDirection: $sortDirection, sortKey: $sortKey, filters: $filters) { + nodes { + ...Product + } + pageInfo { + hasNextPage + hasPreviousPage + } + totalCount + } + } + }`, + }); + + const products = data.search?.products?.nodes ?? []; + const pageInfo = data.search?.products?.pageInfo; + + const nextPage = new URLSearchParams(url.searchParams); + const previousPage = new URLSearchParams(url.searchParams); + + if (pageInfo?.hasNextPage) { + nextPage.set("page", (page + 1).toString()); + } + if (pageInfo?.hasPreviousPage) { + previousPage.set("page", (page - 1).toString()); + } + + const itemListElement: ProductListingPage["breadcrumb"]["itemListElement"] = + data.search?.breadcrumbs?.map((b, i) => ({ + "@type": "ListItem", + position: i + 1, + item: b!.link!, + name: b!.text!, + })) ?? []; + + return { + "@type": "ProductListingPage", + filters: toFilters(data.search?.aggregations, { base: url }), + pageInfo: { + nextPage: pageInfo?.hasNextPage ? `?${nextPage}` : undefined, + previousPage: pageInfo?.hasPreviousPage ? `?${previousPage}` : undefined, + currentPage: page, + records: data.search?.products?.totalCount, + recordPerPage: first, + }, + sortOptions: SORT_OPTIONS, + breadcrumb: { + "@type": "BreadcrumbList", + itemListElement, + numberOfItems: itemListElement.length, + }, + products: products + ?.filter((p): p is ProductFragment => Boolean(p)) + .map((variant) => toProduct(variant, { base: url })), + }; +}; + +export default searchLoader; diff --git a/wake/loaders/proxy.ts b/wake/loaders/proxy.ts new file mode 100644 index 000000000..09110258f --- /dev/null +++ b/wake/loaders/proxy.ts @@ -0,0 +1,35 @@ +import { Route } from "../../website/flags/audience.ts"; +import { AppContext } from "../mod.ts"; + +/** + * @title Wake Proxy Routes + */ +function loader( + _props: unknown, + _req: Request, + { account }: AppContext, +): Route[] { + const checkout = [ + ["/checkout", "/checkout"], + ["/Fechamento"], + ["/Login"], + ["/login/*"], + ["/api/*"], + ].map(([pathTemplate, basePath]) => ({ + pathTemplate, + handler: { + value: { + __resolveType: "website/handlers/proxy.ts", + url: `https://${account}.checkout.fbits.store`, + basePath, + customHeaders: { + Host: "erploja2.checkout.fbits.store", + }, + }, + }, + })); + + return checkout; +} + +export default loader; diff --git a/wake/manifest.gen.ts b/wake/manifest.gen.ts new file mode 100644 index 000000000..6894a7e83 --- /dev/null +++ b/wake/manifest.gen.ts @@ -0,0 +1,35 @@ +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// This file is automatically updated during development when running `dev.ts`. + +import * as $$$0 from "./loaders/productList.ts"; +import * as $$$1 from "./loaders/productDetailsPage.ts"; +import * as $$$2 from "./loaders/productListingPage.ts"; +import * as $$$3 from "./loaders/proxy.ts"; +import * as $$$4 from "./loaders/cart.ts"; +import * as $$$$$$$$$0 from "./actions/cart/addCoupon.ts"; +import * as $$$$$$$$$1 from "./actions/cart/addItem.ts"; +import * as $$$$$$$$$2 from "./actions/cart/updateItemQuantity.ts"; +import * as $$$$$$$$$3 from "./actions/cart/removeCoupon.ts"; + +const manifest = { + "loaders": { + "wake/loaders/cart.ts": $$$4, + "wake/loaders/productDetailsPage.ts": $$$1, + "wake/loaders/productList.ts": $$$0, + "wake/loaders/productListingPage.ts": $$$2, + "wake/loaders/proxy.ts": $$$3, + }, + "actions": { + "wake/actions/cart/addCoupon.ts": $$$$$$$$$0, + "wake/actions/cart/addItem.ts": $$$$$$$$$1, + "wake/actions/cart/removeCoupon.ts": $$$$$$$$$3, + "wake/actions/cart/updateItemQuantity.ts": $$$$$$$$$2, + }, + "name": "wake", + "baseUrl": import.meta.url, +}; + +export type Manifest = typeof manifest; + +export default manifest; diff --git a/wake/mod.ts b/wake/mod.ts new file mode 100644 index 000000000..8df5f3c5c --- /dev/null +++ b/wake/mod.ts @@ -0,0 +1,63 @@ +import type { App, FnContext } from "deco/mod.ts"; +import { createHttpClient } from "../utils/http.ts"; +import manifest, { Manifest } from "./manifest.gen.ts"; +import { API } from "./utils/openapi/openapi.gen.ts"; +import { fetchSafe } from "../utils/fetch.ts"; +import { createGraphqlClient } from "../utils/graphql.ts"; + +export type AppContext = FnContext; + +/** @title Wake */ +export interface Props { + /** + * @title Account Name + * @description erploja2 etc + */ + account: string; + + /** + * @title Wake Storefront Token + * @description https://wakecommerce.readme.io/docs/storefront-api-criacao-e-autenticacao-do-token + */ + storefrontToken: string; + + /** + * @title Wake API token + * @description The token for accessing wake commerce + * @default deco + */ + token?: string; + + /** + * @description Use Wake as backend platform + */ + platform: "wake"; +} + +export interface State extends Props { + api: ReturnType>; + storefront: ReturnType; +} + +/** + * @title Wake + */ +export default function App(props: Props): App { + const { token, storefrontToken } = props; + const api = createHttpClient({ + base: "https://api.fbits.net", + headers: new Headers({ "Authorization": `Basic ${token}` }), + fetcher: fetchSafe, + }); + + const storefront = createGraphqlClient({ + endpoint: "https://storefront-api.fbits.net/graphql", + headers: new Headers({ "TCS-Access-Token": storefrontToken }), + fetcher: fetchSafe, + }); + + return { + state: { ...props, api, storefront }, + manifest, + }; +} diff --git a/wake/runtime.ts b/wake/runtime.ts new file mode 100644 index 000000000..41d65a98d --- /dev/null +++ b/wake/runtime.ts @@ -0,0 +1,4 @@ +import { proxy } from "deco/clients/withManifest.ts"; +import { Manifest } from "./manifest.gen.ts"; + +export const invoke = proxy(); diff --git a/wake/utils/cart.ts b/wake/utils/cart.ts new file mode 100644 index 000000000..1a3985c2e --- /dev/null +++ b/wake/utils/cart.ts @@ -0,0 +1,22 @@ +import { getCookies, setCookie } from "std/http/cookie.ts"; + +const CART_COOKIE = "carrinho-id"; + +const ONE_WEEK_MS = 7 * 24 * 3600 * 1_000; + +export const getCartCookie = (headers: Headers): string | undefined => { + const cookies = getCookies(headers); + + return cookies[CART_COOKIE]; +}; + +export const setCartCookie = (headers: Headers, cartId: string) => + setCookie(headers, { + name: CART_COOKIE, + value: cartId, + path: "/", + expires: new Date(Date.now() + ONE_WEEK_MS), + httpOnly: true, + secure: true, + sameSite: "Lax", + }); diff --git a/wake/utils/graphql/fragments/checkout.ts b/wake/utils/graphql/fragments/checkout.ts new file mode 100644 index 000000000..36b4299b5 --- /dev/null +++ b/wake/utils/graphql/fragments/checkout.ts @@ -0,0 +1,25 @@ +import { gql } from "../../../../utils/graphql.ts"; + +export const fragment = gql` +fragment Checkout on Checkout { + checkoutId + shippingFee + subtotal + total + completed + coupon + products { + imageUrl + brand + ajustedPrice + listPrice + price + name + productId + productVariantId + quantity + sku + url + } +} +`; diff --git a/wake/utils/graphql/fragments/product.ts b/wake/utils/graphql/fragments/product.ts new file mode 100644 index 000000000..6c6384b12 --- /dev/null +++ b/wake/utils/graphql/fragments/product.ts @@ -0,0 +1,86 @@ +import { gql } from "../../../../utils/graphql.ts"; + +export const fragment = gql` +fragment Product on Product { + mainVariant + productName + productId + alias + attributes { + value + name + } + productCategories { + name + url + hierarchy + main + googleCategories + } + informations { + title + value + type + } + available + averageRating + condition + createdAt + ean + id + images { + url + fileName + print + } + minimumOrderQuantity + prices { + bestInstallment { + discount + displayName + fees + name + number + value + } + discountPercentage + discounted + installmentPlans { + displayName + installments { + discount + fees + number + value + } + name + } + listPrice + multiplicationFactor + price + priceTables { + discountPercentage + id + listPrice + price + } + wholesalePrices { + price + quantity + } + } + productBrand { + fullUrlLogo + logoUrl + name + alias + } + productVariantId + seller { + name + } + sku + stock + variantName +} +`; diff --git a/wake/utils/graphql/fragments/singleProduct.ts b/wake/utils/graphql/fragments/singleProduct.ts new file mode 100644 index 000000000..a4f90605e --- /dev/null +++ b/wake/utils/graphql/fragments/singleProduct.ts @@ -0,0 +1,104 @@ +import { gql } from "../../../../utils/graphql.ts"; + +export const fragment = gql` +fragment SingleProduct on SingleProduct { + mainVariant + productName + productId + alias + attributes { + value + name + } + productCategories { + name + url + hierarchy + main + googleCategories + } + informations { + title + value + type + } + available + averageRating + breadcrumbs { + text + link + } + condition + createdAt + ean + id + images { + url + fileName + print + } + minimumOrderQuantity + prices { + bestInstallment { + discount + displayName + fees + name + number + value + } + discountPercentage + discounted + installmentPlans { + displayName + installments { + discount + fees + number + value + } + name + } + listPrice + multiplicationFactor + price + priceTables { + discountPercentage + id + listPrice + price + } + wholesalePrices { + price + quantity + } + } + productBrand { + fullUrlLogo + logoUrl + name + alias + } + productVariantId + reviews { + rating + review + reviewDate + email + customer + } + seller { + name + } + seo { + name + scheme + type + httpEquiv + content + } + sku + stock + variantName +} +`; diff --git a/wake/utils/graphql/graphql.gen.ts b/wake/utils/graphql/graphql.gen.ts new file mode 100644 index 000000000..6cb74284d --- /dev/null +++ b/wake/utils/graphql/graphql.gen.ts @@ -0,0 +1,3922 @@ +export type Maybe = T | null; +export type InputMaybe = Maybe; +export type Exact = { [K in keyof T]: T[K] }; +export type MakeOptional = Omit & { [SubKey in K]?: Maybe }; +export type MakeMaybe = Omit & { [SubKey in K]: Maybe }; +export type MakeEmpty = { [_ in K]?: never }; +export type Incremental = T | { [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never }; +/** All built-in and custom scalars, mapped to their actual values */ +export type Scalars = { + ID: { input: string; output: string; } + String: { input: string; output: string; } + Boolean: { input: boolean; output: boolean; } + Int: { input: number; output: number; } + Float: { input: number; output: number; } + Any: { input: any; output: any; } + CEP: { input: any; output: any; } + CountryCode: { input: any; output: any; } + DateTime: { input: any; output: any; } + Decimal: { input: any; output: any; } + EmailAddress: { input: any; output: any; } + Long: { input: any; output: any; } + Upload: { input: any; output: any; } + Uuid: { input: any; output: any; } +}; + +/** Price alert input parameters. */ +export type AddPriceAlertInput = { + /** The alerted's email. */ + email: Scalars['String']['input']; + /** The alerted's name. */ + name: Scalars['String']['input']; + /** The product variant id to create the price alert. */ + productVariantId: Scalars['Long']['input']; + /** The google recaptcha token. */ + recaptchaToken?: InputMaybe; + /** The target price to alert. */ + targetPrice: Scalars['Decimal']['input']; +}; + +export type AddressNode = { + /** Zip code. */ + cep?: Maybe; + /** Address city. */ + city?: Maybe; + /** Address country. */ + country?: Maybe; + /** Address neighborhood. */ + neighborhood?: Maybe; + /** Address state. */ + state?: Maybe; + /** Address street. */ + street?: Maybe; +}; + +export type Answer = { + id?: Maybe; + value?: Maybe; +}; + +export type ApplyPolicy = + | 'AFTER_RESOLVER' + | 'BEFORE_RESOLVER'; + +/** Attributes available for the variant products from the given productId. */ +export type Attribute = Node & { + /** The id of the attribute. */ + attributeId: Scalars['Long']['output']; + /** The display type of the attribute. */ + displayType?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The name of the attribute. */ + name?: Maybe; + /** The type of the attribute. */ + type?: Maybe; + /** The values of the attribute. */ + values?: Maybe>>; +}; + +export type AttributeFilterInput = { + attributeId: Scalars['Long']['input']; + value: Scalars['String']['input']; +}; + +/** Input to specify which attributes to match. */ +export type AttributeInput = { + /** The attribute Ids to match. */ + id?: InputMaybe>; + /** The attribute name to match. */ + name?: InputMaybe>>; + /** The attribute type to match. */ + type?: InputMaybe>>; + /** The attribute value to match */ + value?: InputMaybe>>; +}; + +export type AttributeMatrix = { + /** Information about the column attribute. */ + column?: Maybe; + /** The matrix products data. List of rows. */ + data?: Maybe>>>>; + /** Information about the row attribute. */ + row?: Maybe; +}; + +export type AttributeMatrixInfo = { + displayType?: Maybe; + name?: Maybe; + values?: Maybe>>; +}; + +export type AttributeMatrixProduct = { + available: Scalars['Boolean']['output']; + productVariantId: Scalars['Long']['output']; + stock: Scalars['Long']['output']; +}; + +export type AttributeMatrixRowColumnInfoValue = { + printUrl?: Maybe; + value?: Maybe; +}; + + +export type AttributeMatrixRowColumnInfoValuePrintUrlArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Attributes available for the variant products from the given productId. */ +export type AttributeSelection = { + /** Check if the current product attributes can be rendered as a matrix. */ + canBeMatrix: Scalars['Boolean']['output']; + /** The candidate variant given the current input filters. Variant may be from brother product Id. */ + candidateVariant?: Maybe; + /** Informations about the attribute matrix. */ + matrix?: Maybe; + /** The selected variant given the current input filters. Variant may be from brother product Id. */ + selectedVariant?: Maybe; + /** Attributes available for the variant products from the given productId. */ + selections?: Maybe>>; +}; + +/** Attributes available for the variant products from the given productId. */ +export type AttributeSelectionOption = { + /** The id of the attribute. */ + attributeId: Scalars['Long']['output']; + /** The display type of the attribute. */ + displayType?: Maybe; + /** The name of the attribute. */ + name?: Maybe; + /** The values of the attribute. */ + values?: Maybe>>; + /** If the attributes varies by parent. */ + varyByParent: Scalars['Boolean']['output']; +}; + +export type AttributeSelectionOptionValue = { + alias?: Maybe; + available: Scalars['Boolean']['output']; + printUrl?: Maybe; + selected: Scalars['Boolean']['output']; + /** The value of the attribute. */ + value?: Maybe; +}; + + +export type AttributeSelectionOptionValuePrintUrlArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Attributes values with variants */ +export type AttributeValue = { + /** Product variants that have the attribute. */ + productVariants?: Maybe>>; + /** The value of the attribute. */ + value?: Maybe; +}; + +/** Get query completion suggestion. */ +export type Autocomplete = { + /** Suggested products based on the current query. */ + products?: Maybe>>; + /** List of possible query completions. */ + suggestions?: Maybe>>; +}; + +/** A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click. */ +export type Banner = Node & { + /** Banner's alternative text. */ + altText?: Maybe; + /** Banner unique identifier. */ + bannerId: Scalars['Long']['output']; + /** Banner's name. */ + bannerName?: Maybe; + /** URL where the banner is stored. */ + bannerUrl?: Maybe; + /** The date the banner was created. */ + creationDate?: Maybe; + /** Field to check if the banner should be displayed on all pages. */ + displayOnAllPages: Scalars['Boolean']['output']; + /** Field to check if the banner should be displayed on category pages. */ + displayOnCategories: Scalars['Boolean']['output']; + /** Field to check if the banner should be displayed on search pages. */ + displayOnSearches: Scalars['Boolean']['output']; + /** Field to check if the banner should be displayed on the website. */ + displayOnWebsite: Scalars['Boolean']['output']; + /** Field to check if the banner should be displayed to partners. */ + displayToPartners: Scalars['Boolean']['output']; + /** The banner's height in px. */ + height?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** Field to check if the banner URL should open in another tab on click. */ + openNewTab: Scalars['Boolean']['output']; + /** The displaying order of the banner. */ + order: Scalars['Int']['output']; + /** The displaying position of the banner. */ + position?: Maybe; + /** A list of terms to display the banner on search. */ + searchTerms?: Maybe>>; + /** The banner's title. */ + title?: Maybe; + /** URL to be redirected on click. */ + urlOnClick?: Maybe; + /** The banner's width in px. */ + width?: Maybe; +}; + +/** Define the banner attribute which the result set will be sorted on. */ +export type BannerSortKeys = + /** The banner's creation date. */ + | 'CREATION_DATE' + /** The banner's unique identifier. */ + | 'ID'; + +/** A connection to a list of items. */ +export type BannersConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** An edge in a connection. */ +export type BannersEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +export type BestInstallment = { + /** Wether the installment has discount. */ + discount: Scalars['Boolean']['output']; + /** The custom display name of the best installment plan option. */ + displayName?: Maybe; + /** Wether the installment has fees. */ + fees: Scalars['Boolean']['output']; + /** The name of the best installment plan option. */ + name?: Maybe; + /** The number of installments. */ + number: Scalars['Int']['output']; + /** The value of the installment. */ + value: Scalars['Decimal']['output']; +}; + +/** Informations about brands and its products. */ +export type Brand = Node & { + /** If the brand is active at the platform. */ + active: Scalars['Boolean']['output']; + /** The alias for the brand's hotsite. */ + alias?: Maybe; + /** Brand unique identifier. */ + brandId: Scalars['Long']['output']; + /** The date the brand was created in the database. */ + createdAt: Scalars['DateTime']['output']; + /** The full brand logo URL. */ + fullUrlLogo?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The brand's name. */ + name?: Maybe; + /** A list of products from the brand. */ + products?: Maybe; + /** The last update date. */ + updatedAt: Scalars['DateTime']['output']; + /** A web address to be redirected. */ + urlCarrossel?: Maybe; + /** A web address linked to the brand. */ + urlLink?: Maybe; + /** The url of the brand's logo. */ + urlLogo?: Maybe; +}; + + +/** Informations about brands and its products. */ +export type BrandFullUrlLogoArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + + +/** Informations about brands and its products. */ +export type BrandProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: ProductSortKeys; +}; + +/** Filter brand results based on giving attributes. */ +export type BrandFilterInput = { + /** Its unique identifier (you may provide a list of IDs if needed). */ + brandIds?: InputMaybe>; + /** Its brand group unique identifier (you may provide a list of IDs if needed). */ + groupIds?: InputMaybe>; + /** The set of group brand names which the result item name must be included in. */ + groupNames?: InputMaybe>>; + /** The set of brand names which the result item name must be included in. */ + names?: InputMaybe>>; +}; + +/** Define the brand attribute which the result set will be sorted on. */ +export type BrandSortKeys = + /** The brand unique identifier. */ + | 'ID' + /** The brand name. */ + | 'NAME'; + +/** A connection to a list of items. */ +export type BrandsConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + totalCount: Scalars['Int']['output']; +}; + +/** An edge in a connection. */ +export type BrandsEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +/** Informations about breadcrumb. */ +export type Breadcrumb = { + /** Breadcrumb link. */ + link?: Maybe; + /** Breadcrumb text. */ + text?: Maybe; +}; + +/** BuyBox informations. */ +export type BuyBox = { + /** List of the possibles installment plans. */ + installmentPlans?: Maybe>>; + /** Maximum price among sellers. */ + maximumPrice?: Maybe; + /** Minimum price among sellers. */ + minimumPrice?: Maybe; + /** Quantity of offers. */ + quantityOffers?: Maybe; + /** List of sellers. */ + sellers?: Maybe>>; +}; + +/** A buy list represents a list of items for sale in the store. */ +export type BuyList = Node & { + /** Check if the product can be added to cart directly from spot. */ + addToCartFromSpot?: Maybe; + /** The product url alias. */ + alias?: Maybe; + /** Information about the possible selection attributes. */ + attributeSelections?: Maybe; + /** List of the product attributes. */ + attributes?: Maybe>>; + /** Field to check if the product is available in stock. */ + available?: Maybe; + /** The product average rating. From 0 to 5. */ + averageRating?: Maybe; + /** List of product breadcrumbs. */ + breadcrumbs?: Maybe>>; + /** BuyBox informations. */ + buyBox?: Maybe; + buyListId: Scalars['Int']['output']; + buyListProducts?: Maybe>>; + /** Buy together products. */ + buyTogether?: Maybe>>; + /** The product condition. */ + condition?: Maybe; + /** The product creation date. */ + createdAt?: Maybe; + /** A list of customizations available for the given products. */ + customizations?: Maybe>>; + /** The product delivery deadline. */ + deadline?: Maybe; + /** Check if the product should be displayed. */ + display?: Maybe; + /** Check if the product should be displayed only for partners. */ + displayOnlyPartner?: Maybe; + /** Check if the product should be displayed on search. */ + displaySearch?: Maybe; + /** The product's unique EAN. */ + ean?: Maybe; + /** Check if the product offers free shipping. */ + freeShipping?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** List of the product images. */ + images?: Maybe>>; + /** List of the product insformations. */ + informations?: Maybe>>; + /** Check if its the main variant. */ + mainVariant?: Maybe; + /** The product minimum quantity for an order. */ + minimumOrderQuantity?: Maybe; + /** Check if the product is a new release. */ + newRelease?: Maybe; + /** The number of votes that the average rating consists of. */ + numberOfVotes?: Maybe; + /** Product parallel options information. */ + parallelOptions?: Maybe>>; + /** Parent product unique identifier. */ + parentId?: Maybe; + /** The product prices. */ + prices?: Maybe; + /** Summarized informations about the brand of the product. */ + productBrand?: Maybe; + /** Summarized informations about the categories of the product. */ + productCategories?: Maybe>>; + /** Product unique identifier. */ + productId?: Maybe; + /** The product name. */ + productName?: Maybe; + /** Summarized informations about the subscription of the product. */ + productSubscription?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; + /** List of promotions this product belongs to. */ + promotions?: Maybe>>; + /** List of customer reviews for this product. */ + reviews?: Maybe>>; + /** The product seller. */ + seller?: Maybe; + /** Product SEO informations. */ + seo?: Maybe>>; + /** List of similar products. */ + similarProducts?: Maybe>>; + /** The product's unique SKU. */ + sku?: Maybe; + /** The values of the spot attribute. */ + spotAttributes?: Maybe>>; + /** The product spot information. */ + spotInformation?: Maybe; + /** Check if the product is on spotlight. */ + spotlight?: Maybe; + /** The available stock at the default distribution center. */ + stock?: Maybe; + /** List of the product stocks on different distribution centers. */ + stocks?: Maybe>>; + /** List of subscription groups this product belongs to. */ + subscriptionGroups?: Maybe>>; + /** Check if the product is a telesale. */ + telesales?: Maybe; + /** The product last update date. */ + updatedAt?: Maybe; + /** The product video url. */ + urlVideo?: Maybe; + /** The variant name. */ + variantName?: Maybe; +}; + + +/** A buy list represents a list of items for sale in the store. */ +export type BuyListImagesArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Contains the id and quantity of a product in the buy list. */ +export type BuyListProduct = { + productId: Scalars['Long']['output']; + quantity: Scalars['Int']['output']; +}; + +/** The products to calculate prices. */ +export type CalculatePricesProductsInput = { + productVariantId: Scalars['Long']['input']; + quantity: Scalars['Int']['input']; +}; + +/** A connection to a list of items. */ +export type CategoriesConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** An edge in a connection. */ +export type CategoriesEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +/** Categories are used to arrange your products into different sections by similarity. */ +export type Category = Node & { + /** Category unique identifier. */ + categoryId: Scalars['Long']['output']; + /** A list of child categories, if it exists. */ + children?: Maybe>>; + /** A description to the category. */ + description?: Maybe; + /** Field to check if the category is displayed in the store's menu. */ + displayMenu: Scalars['Boolean']['output']; + /** The hotsite alias. */ + hotsiteAlias?: Maybe; + /** The URL path for the category. */ + hotsiteUrl?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The url to access the image linked to the category. */ + imageUrl?: Maybe; + /** The web address to access the image linked to the category. */ + imageUrlLink?: Maybe; + /** The category's name. */ + name?: Maybe; + /** The parent category, if it exists. */ + parent?: Maybe; + /** The parent category unique identifier. */ + parentCategoryId: Scalars['Long']['output']; + /** The position the category will be displayed. */ + position: Scalars['Int']['output']; + /** A list of products associated with the category. */ + products?: Maybe; + /** A web address linked to the category. */ + urlLink?: Maybe; +}; + + +/** Categories are used to arrange your products into different sections by similarity. */ +export type CategoryProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: ProductSortKeys; +}; + +/** Define the category attribute which the result set will be sorted on. */ +export type CategorySortKeys = + /** The category unique identifier. */ + | 'ID' + /** The category name. */ + | 'NAME'; + +export type Checkout = Node & { + /** The CEP. */ + cep?: Maybe; + /** The checkout unique identifier. */ + checkoutId: Scalars['Uuid']['output']; + /** Indicates if the checkout is completed. */ + completed: Scalars['Boolean']['output']; + /** The coupon for discounts. */ + coupon?: Maybe; + /** The customer associated with the checkout. */ + customer?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + login?: Maybe; + /** The metadata related to this checkout. */ + metadata?: Maybe>>; + /** The checkout orders informations. */ + orders?: Maybe>>; + /** A list of products associated with the checkout. */ + products?: Maybe>>; + /** The selected delivery address for the checkout. */ + selectedAddress?: Maybe; + /** The selected payment method */ + selectedPaymentMethod?: Maybe; + /** Selected Shipping. */ + selectedShipping?: Maybe; + /** The shipping fee. */ + shippingFee: Scalars['Decimal']['output']; + /** The subtotal value. */ + subtotal: Scalars['Decimal']['output']; + /** The total value. */ + total: Scalars['Decimal']['output']; + /** The last update date. */ + updateDate: Scalars['DateTime']['output']; + /** Url for the current checkout id. */ + url?: Maybe; +}; + +/** Represents an address node in the checkout. */ +export type CheckoutAddress = { + /** The street number of the address. */ + addressNumber?: Maybe; + /** The ZIP code of the address. */ + cep: Scalars['Int']['output']; + /** The city of the address. */ + city?: Maybe; + /** The additional address information. */ + complement?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The neighborhood of the address. */ + neighborhood?: Maybe; + /** The reference point for the address. */ + referencePoint?: Maybe; + /** The state of the address. */ + state?: Maybe; + /** The street name of the address. */ + street?: Maybe; +}; + +/** Represents a customer node in the checkout. */ +export type CheckoutCustomer = { + /** Taxpayer identification number for businesses. */ + cnpj?: Maybe; + /** Brazilian individual taxpayer registry identification. */ + cpf?: Maybe; + /** The credit limit of the customer. */ + creditLimit: Scalars['Decimal']['output']; + /** The credit limit balance of the customer. */ + creditLimitBalance: Scalars['Decimal']['output']; + /** Customer's unique identifier. */ + customerId: Scalars['Long']['output']; + /** Customer's name. */ + customerName?: Maybe; + /** The email address of the customer. */ + email?: Maybe; + /** Customer's phone number. */ + phoneNumber?: Maybe; +}; + +export type CheckoutCustomizationInput = { + customizationId: Scalars['Long']['input']; + value?: InputMaybe; +}; + +export type CheckoutMetadataInput = { + key?: InputMaybe; + value?: InputMaybe; +}; + +/** Represents a node in the checkout order. */ +export type CheckoutOrder = { + /** The list of adjustments applied to the order. */ + adjustments?: Maybe>>; + /** The date of the order. */ + date: Scalars['DateTime']['output']; + /** Details of the delivery or store pickup. */ + delivery?: Maybe; + /** The discount value of the order. */ + discountValue: Scalars['Decimal']['output']; + /** The dispatch time text from the shop settings. */ + dispatchTimeText?: Maybe; + /** The interest value of the order. */ + interestValue: Scalars['Decimal']['output']; + /** The ID of the order. */ + orderId: Scalars['Long']['output']; + /** The order status. */ + orderStatus: OrderStatus; + /** The payment information. */ + payment?: Maybe; + /** The list of products in the order. */ + products?: Maybe>>; + /** The shipping value of the order. */ + shippingValue: Scalars['Decimal']['output']; + /** The total value of the order. */ + totalValue: Scalars['Decimal']['output']; +}; + +/** The delivery or store Pickup Address. */ +export type CheckoutOrderAddress = { + /** The street address. */ + address?: Maybe; + /** The ZIP code. */ + cep?: Maybe; + /** The city. */ + city?: Maybe; + /** Additional information or details about the address. */ + complement?: Maybe; + /** Indicates whether the order is for store pickup. */ + isPickupStore: Scalars['Boolean']['output']; + /** The name. */ + name?: Maybe; + /** The neighborhood. */ + neighborhood?: Maybe; + /** . */ + pickupStoreText?: Maybe; +}; + +/** Represents an adjustment applied to checkout. */ +export type CheckoutOrderAdjustment = { + /** The name of the adjustment. */ + name?: Maybe; + /** The type of the adjustment. */ + type?: Maybe; + /** The value of the adjustment. */ + value: Scalars['Decimal']['output']; +}; + +/** The delivery or store pickup details. */ +export type CheckoutOrderDelivery = { + /** The delivery or store pickup address. */ + address?: Maybe; + /** The cost of delivery or pickup. */ + cost: Scalars['Decimal']['output']; + /** The estimated delivery or pickup time, in days. */ + deliveryTime: Scalars['Int']['output']; + /** The name of the recipient. */ + name?: Maybe; +}; + +/** The invoice payment information. */ +export type CheckoutOrderInvoicePayment = { + /** The digitable line. */ + digitableLine?: Maybe; + /** The payment link. */ + paymentLink?: Maybe; +}; + +/** The checkout order payment. */ +export type CheckoutOrderPayment = { + /** The bank invoice payment information. */ + invoice?: Maybe; + /** The name of the payment method. */ + name?: Maybe; + /** The Pix payment information. */ + pix?: Maybe; +}; + +/** This represents a Pix payment node in the checkout order. */ +export type CheckoutOrderPixPayment = { + /** The QR code. */ + qrCode?: Maybe; + /** The expiration date of the QR code. */ + qrCodeExpirationDate?: Maybe; + /** The image URL of the QR code. */ + qrCodeUrl?: Maybe; +}; + +/** Represents a node in the checkout order products. */ +export type CheckoutOrderProduct = { + /** The list of adjustments applied to the product. */ + adjustments?: Maybe>>; + /** The list of attributes of the product. */ + attributes?: Maybe>>; + /** The image URL of the product. */ + imageUrl?: Maybe; + /** The name of the product. */ + name?: Maybe; + /** The ID of the product variant. */ + productVariantId: Scalars['Long']['output']; + /** The quantity of the product. */ + quantity: Scalars['Int']['output']; + /** The value of the product. */ + value: Scalars['Decimal']['output']; +}; + +/** Represents an adjustment applied to a product in the checkout order. */ +export type CheckoutOrderProductAdjustment = { + /** Additional information about the adjustment. */ + additionalInformation?: Maybe; + /** The name of the adjustment. */ + name?: Maybe; + /** The type of the adjustment. */ + type?: Maybe; + /** The value of the adjustment. */ + value: Scalars['Decimal']['output']; +}; + +/** Represents an attribute of a product. */ +export type CheckoutOrderProductAttribute = { + /** The name of the attribute. */ + name?: Maybe; + /** The value of the attribute. */ + value?: Maybe; +}; + +export type CheckoutProductAttributeNode = { + /** The attribute name */ + name?: Maybe; + /** The attribute type */ + type: Scalars['Int']['output']; + /** The attribute value */ + value?: Maybe; +}; + +export type CheckoutProductInput = { + id: Scalars['Uuid']['input']; + products: Array>; +}; + +export type CheckoutProductItemInput = { + customization?: InputMaybe>>; + metadata?: InputMaybe>>; + productVariantId: Scalars['Long']['input']; + quantity: Scalars['Int']['input']; + subscription?: InputMaybe; +}; + +export type CheckoutProductNode = { + /** The product adjusted price */ + ajustedPrice: Scalars['Decimal']['output']; + /** Information about the possible selection attributes. */ + attributeSelections?: Maybe; + /** The product brand */ + brand?: Maybe; + /** The product category */ + category?: Maybe; + /** If the product is a gift */ + gift: Scalars['Boolean']['output']; + /** The product Google category */ + googleCategory?: Maybe>>; + /** The product URL image */ + imageUrl?: Maybe; + /** The product informations */ + informations?: Maybe>>; + /** The product installment fee */ + installmentFee: Scalars['Boolean']['output']; + /** The product installment value */ + installmentValue: Scalars['Decimal']['output']; + /** The product list price */ + listPrice: Scalars['Decimal']['output']; + /** The metadata related to this checkout. */ + metadata?: Maybe>>; + /** The product name */ + name?: Maybe; + /** The product number of installments */ + numberOfInstallments: Scalars['Int']['output']; + /** The product price */ + price: Scalars['Decimal']['output']; + /** The product attributes */ + productAttributes?: Maybe>>; + /** The product unique identifier */ + productId: Scalars['Long']['output']; + /** The product variant unique identifier */ + productVariantId: Scalars['Long']['output']; + /** The product quantity */ + quantity: Scalars['Int']['output']; + /** The product shipping deadline */ + shippingDeadline?: Maybe; + /** The product SKU */ + sku?: Maybe; + /** The product URL */ + url?: Maybe; +}; + + +export type CheckoutProductNodeAttributeSelectionsArgs = { + selected?: InputMaybe>>; +}; + +export type CheckoutShippingDeadlineNode = { + /** The shipping deadline */ + deadline: Scalars['Int']['output']; + /** The shipping description */ + description?: Maybe; + /** The shipping second description */ + secondDescription?: Maybe; + /** The shipping second title */ + secondTitle?: Maybe; + /** The shipping title */ + title?: Maybe; +}; + +export type CheckoutSubscriptionInput = { + recurringTypeId: Scalars['Int']['input']; + subscriptionGroupId: Scalars['Long']['input']; +}; + +/** Contents are used to show things to the user. */ +export type Content = Node & { + /** The content in html to be displayed. */ + content?: Maybe; + /** Content unique identifier. */ + contentId: Scalars['Long']['output']; + /** The date the content was created. */ + creationDate?: Maybe; + /** The content's height in px. */ + height?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The content's position. */ + position?: Maybe; + /** A list of terms to display the content on search. */ + searchTerms?: Maybe>>; + /** The content's title. */ + title?: Maybe; + /** The content's width in px. */ + width?: Maybe; +}; + +/** Define the content attribute which the result set will be sorted on. */ +export type ContentSortKeys = + /** The content's creation date. */ + | 'CreationDate' + /** The content's unique identifier. */ + | 'ID'; + +/** A connection to a list of items. */ +export type ContentsConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** An edge in a connection. */ +export type ContentsEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +export type CreateCustomerAddressInput = { + addressDetails?: InputMaybe; + addressNumber: Scalars['String']['input']; + cep: Scalars['CEP']['input']; + city: Scalars['String']['input']; + country: Scalars['CountryCode']['input']; + email: Scalars['EmailAddress']['input']; + name: Scalars['String']['input']; + neighborhood: Scalars['String']['input']; + phone: Scalars['String']['input']; + referencePoint?: InputMaybe; + state: Scalars['String']['input']; + street: Scalars['String']['input']; +}; + +/** A customer from the store. */ +export type Customer = Node & { + /** Customer's addresses. */ + addresses?: Maybe>>; + /** Customer's birth date. */ + birthDate: Scalars['DateTime']['output']; + /** Customer's business phone number. */ + businessPhoneNumber?: Maybe; + /** Taxpayer identification number for businesses. */ + cnpj?: Maybe; + /** Entities legal name. */ + companyName?: Maybe; + /** Brazilian individual taxpayer registry identification. */ + cpf?: Maybe; + /** Creation Date. */ + creationDate: Scalars['DateTime']['output']; + /** Customer's unique identifier. */ + customerId: Scalars['Long']['output']; + /** Customer's name. */ + customerName?: Maybe; + /** Indicates if it is a natural person or company profile. */ + customerType?: Maybe; + /** Customer's delivery address. */ + deliveryAddress?: Maybe; + /** Customer's email address. */ + email?: Maybe; + /** Customer's gender. */ + gender?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** Customer information groups. */ + informationGroups?: Maybe>>; + /** Customer's mobile phone number. */ + mobilePhoneNumber?: Maybe; + /** List of orders placed by the customer. */ + orders?: Maybe; + /** Statistics about the orders the customer made in a specific timeframe. */ + ordersStatistics?: Maybe; + /** Get info about the associated partners. */ + partners?: Maybe>>; + /** Customer's phone number. */ + phoneNumber?: Maybe; + /** Customer's residential address. */ + residentialAddress?: Maybe; + /** Responsible's name. */ + responsibleName?: Maybe; + /** Registration number Id. */ + rg?: Maybe; + /** State registration number. */ + stateRegistration?: Maybe; + /** Date of the last update. */ + updateDate: Scalars['DateTime']['output']; + /** Customer wishlist. */ + wishlist?: Maybe; +}; + + +/** A customer from the store. */ +export type CustomerOrdersArgs = { + offset?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** A customer from the store. */ +export type CustomerOrdersStatisticsArgs = { + dateGte?: InputMaybe; + dateLt?: InputMaybe; + onlyPaidOrders?: Scalars['Boolean']['input']; + partnerId?: InputMaybe; +}; + + +/** A customer from the store. */ +export type CustomerWishlistArgs = { + productsIds?: InputMaybe>>; +}; + +export type CustomerAccessToken = { + isMaster: Scalars['Boolean']['output']; + token?: Maybe; + /** The user login type */ + type?: Maybe; + validUntil: Scalars['DateTime']['output']; +}; + +/** The input to authenticate a user. */ +export type CustomerAccessTokenInput = { + email: Scalars['String']['input']; + password: Scalars['String']['input']; +}; + +export type CustomerAddressNode = Node & { + /** Address details. */ + addressDetails?: Maybe; + /** Address number. */ + addressNumber?: Maybe; + /** zip code. */ + cep?: Maybe; + /** address city. */ + city?: Maybe; + /** Country. */ + country?: Maybe; + /** The email of the customer address. */ + email?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The name of the customer address. */ + name?: Maybe; + /** Address neighborhood. */ + neighborhood?: Maybe; + /** The phone of the customer address. */ + phone?: Maybe; + /** Address reference point. */ + referencePoint?: Maybe; + /** State. */ + state?: Maybe; + /** Address street. */ + street?: Maybe; +}; + +export type CustomerCreateInput = { + /** The street address for the registered address. */ + address?: InputMaybe; + /** The street address for the registered address. */ + address2?: InputMaybe; + /** Any additional information related to the registered address. */ + addressComplement?: InputMaybe; + /** The building number for the registered address. */ + addressNumber?: InputMaybe; + /** The date of birth of the customer. */ + birthDate?: InputMaybe; + /** The CEP for the registered address. */ + cep?: InputMaybe; + /** The city for the registered address. */ + city?: InputMaybe; + /** The Brazilian tax identification number for corporations. */ + cnpj?: InputMaybe; + /** The legal name of the corporate customer. */ + corporateName?: InputMaybe; + /** The country for the registered address. */ + country?: InputMaybe; + /** The Brazilian tax identification number for individuals. */ + cpf?: InputMaybe; + /** Indicates if it is a natural person or company profile. */ + customerType: EntityType; + /** The email of the customer. */ + email?: InputMaybe; + /** The full name of the customer. */ + fullName?: InputMaybe; + /** The gender of the customer. */ + gender?: InputMaybe; + /** Indicates if the customer is state registration exempt. */ + isStateRegistrationExempt?: InputMaybe; + /** The neighborhood for the registered address. */ + neighborhood?: InputMaybe; + /** Indicates if the customer has subscribed to the newsletter. */ + newsletter?: InputMaybe; + /** The password for the customer's account. */ + password?: InputMaybe; + /** The password confirmation for the customer's account. */ + passwordConfirmation?: InputMaybe; + /** The area code for the customer's primary phone number. */ + primaryPhoneAreaCode?: InputMaybe; + /** The customer's primary phone number. */ + primaryPhoneNumber?: InputMaybe; + /** The name of the receiver for the registered address. */ + receiverName?: InputMaybe; + /** A reference point or description to help locate the registered address. */ + reference?: InputMaybe; + /** Indicates if the customer is a reseller. */ + reseller?: InputMaybe; + /** The area code for the customer's secondary phone number. */ + secondaryPhoneAreaCode?: InputMaybe; + /** The customer's secondary phone number. */ + secondaryPhoneNumber?: InputMaybe; + /** The state for the registered address. */ + state?: InputMaybe; + /** The state registration number for businesses. */ + stateRegistration?: InputMaybe; +}; + +/** The input to change the user email. */ +export type CustomerEmailChangeInput = { + /** The new email. */ + newEmail: Scalars['String']['input']; +}; + +export type CustomerInformationGroupFieldNode = { + /** The field name. */ + name?: Maybe; + /** The field order. */ + order: Scalars['Int']['output']; + /** If the field is required. */ + required: Scalars['Boolean']['output']; + /** The field value. */ + value?: Maybe; +}; + +export type CustomerInformationGroupNode = { + /** The group exibition name. */ + exibitionName?: Maybe; + /** The group fields. */ + fields?: Maybe>>; + /** The group name. */ + name?: Maybe; +}; + +export type CustomerOrderCollectionSegment = { + items?: Maybe>>; + page: Scalars['Int']['output']; + pageSize: Scalars['Int']['output']; + totalCount: Scalars['Int']['output']; +}; + +/** Define the order attribute which the result set will be sorted on. */ +export type CustomerOrderSortKeys = + /** The total order value. */ + | 'AMOUNT' + /** The date the order was placed. */ + | 'DATE' + /** The order ID. */ + | 'ID' + /** The order current status. */ + | 'STATUS'; + +export type CustomerOrdersStatistics = { + /** The number of products the customer made from the number of orders. */ + productsQuantity: Scalars['Int']['output']; + /** The number of orders the customer made. */ + quantity: Scalars['Int']['output']; +}; + +export type CustomerPartnerNode = { + /** The partner alias. */ + alias?: Maybe; + /** The partner's name. */ + name?: Maybe; + /** The partner's access token. */ + partnerAccessToken?: Maybe; +}; + +/** The input to change the user password. */ +export type CustomerPasswordChangeInputGraphInput = { + /** The current password. */ + currentPassword: Scalars['String']['input']; + /** The new password. */ + newPassword: Scalars['String']['input']; +}; + +export type CustomerSimpleCreateInputGraphInput = { + /** The date of birth of the customer. */ + birthDate?: InputMaybe; + /** The Brazilian tax identification number for corporations. */ + cnpj?: InputMaybe; + /** The legal name of the corporate customer. */ + corporateName?: InputMaybe; + /** The Brazilian tax identification number for individuals. */ + cpf?: InputMaybe; + /** Indicates if it is a natural person or company profile. */ + customerType: EntityType; + /** The email of the customer. */ + email?: InputMaybe; + /** The full name of the customer. */ + fullName?: InputMaybe; + /** Indicates if the customer is state registration exempt. */ + isStateRegistrationExempt?: InputMaybe; + /** The area code for the customer's primary phone number. */ + primaryPhoneAreaCode?: InputMaybe; + /** The customer's primary phone number. */ + primaryPhoneNumber?: InputMaybe; + /** The state registration number for businesses. */ + stateRegistration?: InputMaybe; +}; + +export type CustomerUpdateInput = { + /** The date of birth of the customer. */ + birthDate?: InputMaybe; + /** The Brazilian tax identification number for corporations. */ + cnpj?: InputMaybe; + /** The legal name of the corporate customer. */ + corporateName?: InputMaybe; + /** The Brazilian tax identification number for individuals. */ + cpf?: InputMaybe; + /** Indicates if it is a natural person or company profile. */ + customerType: EntityType; + /** The full name of the customer. */ + fullName?: InputMaybe; + /** The gender of the customer. */ + gender?: InputMaybe; + /** The area code for the customer's primary phone number. */ + primaryPhoneAreaCode?: InputMaybe; + /** The customer's primary phone number. */ + primaryPhoneNumber?: InputMaybe; + /** The Brazilian register identification number for individuals. */ + rg?: InputMaybe; + /** The area code for the customer's secondary phone number. */ + secondaryPhoneAreaCode?: InputMaybe; + /** The customer's secondary phone number. */ + secondaryPhoneNumber?: InputMaybe; + /** The state registration number for businesses. */ + stateRegistration?: InputMaybe; +}; + +/** Some products can have customizations, such as writing your name on it or other predefined options. */ +export type Customization = Node & { + /** Cost of customization. */ + cost: Scalars['Decimal']['output']; + /** Customization unique identifier. */ + customizationId: Scalars['Long']['output']; + /** Customization group's name. */ + groupName?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** Maximum allowed size of the field. */ + maxLength: Scalars['Int']['output']; + /** The customization's name. */ + name?: Maybe; + /** Priority order of customization. */ + order: Scalars['Int']['output']; + /** Type of customization. */ + type?: Maybe; + /** Value of customization. */ + values?: Maybe>>; +}; + +/** The delivery schedule detail. */ +export type DeliveryScheduleDetail = { + /** The date of the delivery schedule. */ + date?: Maybe; + /** The end date and time of the delivery schedule. */ + endDateTime: Scalars['DateTime']['output']; + /** The end time of the delivery schedule. */ + endTime?: Maybe; + /** The start date and time of the delivery schedule. */ + startDateTime: Scalars['DateTime']['output']; + /** The start time of the delivery schedule. */ + startTime?: Maybe; +}; + +/** Input for delivery scheduling. */ +export type DeliveryScheduleInput = { + /** The date. */ + date: Scalars['DateTime']['input']; + /** The period ID. */ + periodId: Scalars['Long']['input']; +}; + +/** Define the entity type of the customer registration. */ +export type EntityType = + /** Legal entity, a company, business, organization. */ + | 'COMPANY' + /** An international person, a legal international entity. */ + | 'INTERNATIONAL' + /** An individual person, a physical person. */ + | 'PERSON'; + +export type FilterPosition = + /** Both filter position. */ + | 'BOTH' + /** Horizontal filter position. */ + | 'HORIZONTAL' + /** Vertical filter position. */ + | 'VERTICAL'; + +/** The customer's gender. */ +export type Gender = + | 'FEMALE' + | 'MALE'; + +/** A hotsite is a group of products used to organize them or to make them easier to browse. */ +export type Hotsite = Node & { + /** A list of banners associated with the hotsite. */ + banners?: Maybe>>; + /** A list of contents associated with the hotsite. */ + contents?: Maybe>>; + /** The hotsite will be displayed until this date. */ + endDate?: Maybe; + /** Expression used to associate products to the hotsite. */ + expression?: Maybe; + /** Hotsite unique identifier. */ + hotsiteId: Scalars['Long']['output']; + /** The node unique identifier. */ + id?: Maybe; + /** The hotsite's name. */ + name?: Maybe; + /** Set the quantity of products displayed per page. */ + pageSize: Scalars['Int']['output']; + /** A list of products associated with the hotsite. */ + products?: Maybe; + /** Sorting information to be used by default on the hotsite. */ + sorting?: Maybe; + /** The hotsite will be displayed from this date. */ + startDate?: Maybe; + /** The subtype of the hotsite. */ + subtype?: Maybe; + /** The template used for the hotsite. */ + template?: Maybe; + /** The hotsite's URL. */ + url?: Maybe; +}; + + +/** A hotsite is a group of products used to organize them or to make them easier to browse. */ +export type HotsiteProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Define the hotsite attribute which the result set will be sorted on. */ +export type HotsiteSortKeys = + /** The hotsite id. */ + | 'ID' + /** The hotsite name. */ + | 'NAME' + /** The hotsite url. */ + | 'URL'; + +export type HotsiteSorting = { + direction?: Maybe; + field?: Maybe; +}; + +export type HotsiteSubtype = + /** Hotsite created from a brand. */ + | 'BRAND' + /** Hotsite created from a buy list (lista de compra). */ + | 'BUY_LIST' + /** Hotsite created from a category. */ + | 'CATEGORY' + /** Hotsite created from a portfolio. */ + | 'PORTFOLIO'; + +/** A connection to a list of items. */ +export type HotsitesConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** An edge in a connection. */ +export type HotsitesEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +/** Informations about an image of a product. */ +export type Image = { + /** The name of the image file. */ + fileName?: Maybe; + /** Check if the image is used for the product main image. */ + mini: Scalars['Boolean']['output']; + /** Numeric order the image should be displayed. */ + order: Scalars['Int']['output']; + /** Check if the image is used for the product prints only. */ + print: Scalars['Boolean']['output']; + /** The url to retrieve the image */ + url?: Maybe; +}; + +/** The additional information about in-store pickup */ +export type InStorePickupAdditionalInformationInput = { + /** The document */ + document?: InputMaybe; + /** The name */ + name?: InputMaybe; +}; + +/** Information registred to the product. */ +export type Information = { + /** The information id. */ + id: Scalars['Long']['output']; + /** The information title. */ + title?: Maybe; + /** The information type. */ + type?: Maybe; + /** The information value. */ + value?: Maybe; +}; + +export type InformationGroupFieldNode = Node & { + /** The information group field display type. */ + displayType?: Maybe; + /** The information group field name. */ + fieldName?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The information group field order. */ + order: Scalars['Int']['output']; + /** If the information group field is required. */ + required: Scalars['Boolean']['output']; + /** The information group field preset values. */ + values?: Maybe>>; +}; + +export type InformationGroupFieldValueNode = { + /** The information group field value order. */ + order: Scalars['Int']['output']; + /** The information group field value. */ + value?: Maybe; +}; + +export type InformationGroupValueInput = { + /** The information group field unique identifier. */ + id?: InputMaybe; + /** The information group field value. */ + value?: InputMaybe; +}; + +export type Installment = { + /** Wether the installment has discount. */ + discount: Scalars['Boolean']['output']; + /** Wether the installment has fees. */ + fees: Scalars['Boolean']['output']; + /** The number of installments. */ + number: Scalars['Int']['output']; + /** The value of the installment. */ + value: Scalars['Decimal']['output']; +}; + +export type InstallmentPlan = { + /** The custom display name of this installment plan. */ + displayName?: Maybe; + /** List of the installments. */ + installments?: Maybe>>; + /** The name of this installment plan. */ + name?: Maybe; +}; + +/** The user login type. */ +export type LoginType = + | 'AUTHENTICATED' + | 'NEW' + | 'SIMPLE'; + +/** Informations about menu items. */ +export type Menu = Node & { + /** Menu css class to apply. */ + cssClass?: Maybe; + /** The full image URL. */ + fullImageUrl?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** Menu image url address. */ + imageUrl?: Maybe; + /** Menu hierarchy level. */ + level: Scalars['Int']['output']; + /** Menu link address. */ + link?: Maybe; + /** Menu group identifier. */ + menuGroupId: Scalars['Int']['output']; + /** Menu identifier. */ + menuId: Scalars['Int']['output']; + /** Menu name. */ + name: Scalars['String']['output']; + /** Menu hierarchy level. */ + openNewTab: Scalars['Boolean']['output']; + /** Menu position order. */ + order: Scalars['Int']['output']; + /** Parent menu identifier. */ + parentMenuId?: Maybe; + /** Menu extra text. */ + text?: Maybe; +}; + + +/** Informations about menu items. */ +export type MenuFullImageUrlArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Informations about menu groups. */ +export type MenuGroup = Node & { + /** The full image URL. */ + fullImageUrl?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** Menu group image url. */ + imageUrl?: Maybe; + /** Menu group identifier. */ + menuGroupId: Scalars['Int']['output']; + /** List of menus associated with the current group */ + menus?: Maybe>>; + /** Menu group name. */ + name?: Maybe; + /** Menu group partner id. */ + partnerId?: Maybe; + /** Menu group position. */ + position?: Maybe; +}; + + +/** Informations about menu groups. */ +export type MenuGroupFullImageUrlArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Some products can have metadata, like diferent types of custom information. A basic key value pair. */ +export type Metadata = { + /** Metadata key. */ + key?: Maybe; + /** Metadata value. */ + value?: Maybe; +}; + +export type Mutation = { + /** Add coupon to checkout */ + checkoutAddCoupon?: Maybe; + /** Add metadata to checkout */ + checkoutAddMetadata?: Maybe; + /** Add metadata to a checkout product */ + checkoutAddMetadataForProductVariant?: Maybe; + /** Add products to an existing checkout */ + checkoutAddProduct?: Maybe; + /** Associate the address with a checkout. */ + checkoutAddressAssociate?: Maybe; + /** Clones a cart by the given checkout ID, returns the newly created checkout ID */ + checkoutClone?: Maybe; + /** Completes a checkout */ + checkoutComplete?: Maybe; + /** Associate the customer with a checkout. */ + checkoutCustomerAssociate?: Maybe; + /** Selects the variant of a gift product */ + checkoutGiftVariantSelection?: Maybe; + /** Associate the partner with a checkout. */ + checkoutPartnerAssociate?: Maybe; + /** Add coupon to checkout */ + checkoutRemoveCoupon?: Maybe; + /** Remove products from an existing checkout */ + checkoutRemoveProduct?: Maybe; + /** Select installment. */ + checkoutSelectInstallment?: Maybe; + /** Select payment method. */ + checkoutSelectPaymentMethod?: Maybe; + /** Select shipping quote */ + checkoutSelectShippingQuote?: Maybe; + /** Create a new checkout */ + createCheckout?: Maybe; + /** Register an email in the newsletter. */ + createNewsletterRegister?: Maybe; + /** Adds a review to a product variant. */ + createProductReview?: Maybe; + /** Record a searched term for admin reports */ + createSearchTermRecord?: Maybe; + /** Creates a new customer access token with an expiration time. */ + customerAccessTokenCreate?: Maybe; + /** Renews the expiration time of a customer access token. The token must not be expired. */ + customerAccessTokenRenew?: Maybe; + /** Create an address. */ + customerAddressCreate?: Maybe; + /** Change an existing address */ + customerAddressUpdate?: Maybe; + /** Allows the user to complete the required information for a partial registration. */ + customerCompletePartialRegistration?: Maybe; + /** Creates a new customer register. */ + customerCreate?: Maybe; + /** Changes user email. */ + customerEmailChange?: Maybe; + /** Impersonates a customer, generating an access token with expiration time. */ + customerImpersonate?: Maybe; + /** Changes user password. */ + customerPasswordChange?: Maybe; + /** Sends a password recovery email to the user. */ + customerPasswordRecovery?: Maybe; + /** Returns the user associated with a simple login (CPF or Email) if exists, else return a New user. */ + customerSimpleLoginStart?: Maybe; + /** Verify if the answer to a simple login question is correct, returns a new question if the answer is incorrect */ + customerSimpleLoginVerifyAnwser?: Maybe; + /** Returns the user associated with a Facebook account if exists, else return a New user. */ + customerSocialLoginFacebook?: Maybe; + /** Returns the user associated with a Google account if exists, else return a New user. */ + customerSocialLoginGoogle?: Maybe; + /** Updates a customer register. */ + customerUpdate?: Maybe; + /** Creates a new closed scope partner access token with an expiration time. */ + partnerAccessTokenCreate?: Maybe; + /** Add a price alert. */ + productPriceAlert?: Maybe; + /** Creates an alert to notify when the product is back in stock. */ + productRestockAlert?: Maybe; + /** Send a generic form. */ + sendGenericForm?: Maybe; + /** + * Change an existing address + * @deprecated Use the CustomerAddressUpdate mutation. + */ + updateAddress?: Maybe; + /** Adds a product to the customer's wishlist. */ + wishlistAddProduct?: Maybe>>; + /** Removes a product from the customer's wishlist. */ + wishlistRemoveProduct?: Maybe>>; +}; + + +export type MutationCheckoutAddCouponArgs = { + checkoutId: Scalars['Uuid']['input']; + coupon: Scalars['String']['input']; + customerAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCheckoutAddMetadataArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + metadata: Array>; +}; + + +export type MutationCheckoutAddMetadataForProductVariantArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + metadata: Array>; + productVariantId: Scalars['Long']['input']; +}; + + +export type MutationCheckoutAddProductArgs = { + customerAccessToken?: InputMaybe; + input: CheckoutProductInput; +}; + + +export type MutationCheckoutAddressAssociateArgs = { + addressId: Scalars['ID']['input']; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken: Scalars['String']['input']; +}; + + +export type MutationCheckoutCloneArgs = { + checkoutId: Scalars['Uuid']['input']; + copyUser?: Scalars['Boolean']['input']; + customerAccessToken?: InputMaybe; +}; + + +export type MutationCheckoutCompleteArgs = { + checkoutId: Scalars['Uuid']['input']; + comments?: InputMaybe; + customerAccessToken?: InputMaybe; + paymentData: Scalars['String']['input']; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCheckoutCustomerAssociateArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken: Scalars['String']['input']; +}; + + +export type MutationCheckoutGiftVariantSelectionArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + productVariantId: Scalars['Long']['input']; +}; + + +export type MutationCheckoutPartnerAssociateArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + partnerAccessToken: Scalars['String']['input']; +}; + + +export type MutationCheckoutRemoveCouponArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; +}; + + +export type MutationCheckoutRemoveProductArgs = { + customerAccessToken?: InputMaybe; + input: CheckoutProductInput; +}; + + +export type MutationCheckoutSelectInstallmentArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + installmentNumber: Scalars['Int']['input']; + selectedPaymentMethodId: Scalars['Uuid']['input']; +}; + + +export type MutationCheckoutSelectPaymentMethodArgs = { + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + paymentMethodId: Scalars['ID']['input']; +}; + + +export type MutationCheckoutSelectShippingQuoteArgs = { + additionalInformation?: InputMaybe; + checkoutId: Scalars['Uuid']['input']; + customerAccessToken?: InputMaybe; + deliveryScheduleInput?: InputMaybe; + shippingQuoteId: Scalars['Uuid']['input']; +}; + + +export type MutationCreateCheckoutArgs = { + products?: InputMaybe>>; +}; + + +export type MutationCreateNewsletterRegisterArgs = { + input: NewsletterInput; +}; + + +export type MutationCreateProductReviewArgs = { + input: ReviewCreateInput; +}; + + +export type MutationCreateSearchTermRecordArgs = { + input: SearchRecordInput; +}; + + +export type MutationCustomerAccessTokenCreateArgs = { + input: CustomerAccessTokenInput; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerAccessTokenRenewArgs = { + customerAccessToken: Scalars['String']['input']; +}; + + +export type MutationCustomerAddressCreateArgs = { + address: CreateCustomerAddressInput; + customerAccessToken: Scalars['String']['input']; +}; + + +export type MutationCustomerAddressUpdateArgs = { + address: UpdateCustomerAddressInput; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + +export type MutationCustomerCompletePartialRegistrationArgs = { + customerAccessToken: Scalars['String']['input']; + input?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerCreateArgs = { + input?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerEmailChangeArgs = { + customerAccessToken: Scalars['String']['input']; + input?: InputMaybe; +}; + + +export type MutationCustomerImpersonateArgs = { + customerAccessToken: Scalars['String']['input']; + input: Scalars['String']['input']; +}; + + +export type MutationCustomerPasswordChangeArgs = { + customerAccessToken: Scalars['String']['input']; + input?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerPasswordRecoveryArgs = { + input: Scalars['String']['input']; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerSimpleLoginStartArgs = { + input?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerSimpleLoginVerifyAnwserArgs = { + anwserId: Scalars['Uuid']['input']; + input?: InputMaybe; + questionId: Scalars['Uuid']['input']; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerSocialLoginFacebookArgs = { + facebookAccessToken?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationCustomerSocialLoginGoogleArgs = { + clientId?: InputMaybe; + recaptchaToken?: InputMaybe; + userCredential?: InputMaybe; +}; + + +export type MutationCustomerUpdateArgs = { + customerAccessToken: Scalars['String']['input']; + input: CustomerUpdateInput; +}; + + +export type MutationPartnerAccessTokenCreateArgs = { + input: PartnerAccessTokenInput; +}; + + +export type MutationProductPriceAlertArgs = { + input: AddPriceAlertInput; +}; + + +export type MutationProductRestockAlertArgs = { + input: RestockAlertInput; + partnerAccessToken?: InputMaybe; +}; + + +export type MutationSendGenericFormArgs = { + body?: InputMaybe; + file?: InputMaybe; + recaptchaToken?: InputMaybe; +}; + + +export type MutationUpdateAddressArgs = { + address: UpdateCustomerAddressInput; + customerAccessToken: Scalars['String']['input']; + id: Scalars['ID']['input']; +}; + + +export type MutationWishlistAddProductArgs = { + customerAccessToken: Scalars['String']['input']; + productId: Scalars['Long']['input']; +}; + + +export type MutationWishlistRemoveProductArgs = { + customerAccessToken: Scalars['String']['input']; + productId: Scalars['Long']['input']; +}; + +export type NewsletterInput = { + email: Scalars['String']['input']; + informationGroupValues?: InputMaybe>>; + name: Scalars['String']['input']; + recaptchaToken?: InputMaybe; +}; + +export type NewsletterNode = { + /** Newsletter creation date. */ + createDate: Scalars['DateTime']['output']; + /** The newsletter receiver email. */ + email?: Maybe; + /** The newsletter receiver name. */ + name?: Maybe; + /** Newsletter update date. */ + updateDate?: Maybe; +}; + +export type Node = { + id?: Maybe; +}; + +/** Types of operations to perform between query terms. */ +export type Operation = + /** Performs AND operation between query terms. */ + | 'AND' + /** Performs OR operation between query terms. */ + | 'OR'; + +/** Result of the operation. */ +export type OperationResult = { + /** If the operation is a success. */ + isSuccess: Scalars['Boolean']['output']; +}; + +export type OrderAdjustNode = { + /** The adjust name. */ + name?: Maybe; + /** Note about the adjust. */ + note?: Maybe; + /** Type of adjust. */ + type?: Maybe; + /** Amount to be adjusted. */ + value: Scalars['Decimal']['output']; +}; + +export type OrderAttributeNode = { + /** The attribute name. */ + name?: Maybe; + /** The attribute value. */ + value?: Maybe; +}; + +export type OrderCustomizationNode = { + /** The customization cost. */ + cost?: Maybe; + /** The customization name. */ + name?: Maybe; + /** The customization value. */ + value?: Maybe; +}; + +export type OrderDeliveryAddressNode = { + /** The street number of the address. */ + addressNumber?: Maybe; + /** The ZIP code of the address. */ + cep?: Maybe; + /** The city of the address. */ + city?: Maybe; + /** The additional address information. */ + complement?: Maybe; + /** The country of the address. */ + country?: Maybe; + /** The neighborhood of the address. */ + neighboorhood?: Maybe; + /** The receiver's name. */ + receiverName?: Maybe; + /** The reference point for the address. */ + referencePoint?: Maybe; + /** The state of the address, abbreviated. */ + state?: Maybe; + /** The street name of the address. */ + street?: Maybe; +}; + +export type OrderInvoiceNode = { + /** The invoice access key. */ + accessKey?: Maybe; + /** The invoice identifier code. */ + invoiceCode?: Maybe; + /** The invoice serial digit. */ + serialDigit?: Maybe; + /** The invoice URL. */ + url?: Maybe; +}; + +export type OrderNoteNode = { + /** Date the note was added to the order. */ + date?: Maybe; + /** The note added to the order. */ + note?: Maybe; + /** The user who added the note to the order. */ + user?: Maybe; +}; + +export type OrderPackagingNode = { + /** The packaging cost. */ + cost: Scalars['Decimal']['output']; + /** The packaging description. */ + description?: Maybe; + /** The message added to the packaging. */ + message?: Maybe; + /** The packaging name. */ + name?: Maybe; +}; + +export type OrderPaymentAdditionalInfoNode = { + /** Additional information key. */ + key?: Maybe; + /** Additional information value. */ + value?: Maybe; +}; + +export type OrderPaymentBoletoNode = { + /** The digitable line. */ + digitableLine?: Maybe; + /** The payment link. */ + paymentLink?: Maybe; +}; + +export type OrderPaymentCardNode = { + /** The brand of the card. */ + brand?: Maybe; + /** The masked credit card number with only the last 4 digits displayed. */ + maskedNumber?: Maybe; +}; + +export type OrderPaymentNode = { + /** Additional information for the payment. */ + additionalInfo?: Maybe>>; + /** The boleto information. */ + boleto?: Maybe; + /** The card information. */ + card?: Maybe; + /** Order discounted value. */ + discount?: Maybe; + /** Order additional fees value. */ + fees?: Maybe; + /** Value per installment. */ + installmentValue?: Maybe; + /** Number of installments. */ + installments?: Maybe; + /** Message about payment transaction. */ + message?: Maybe; + /** The chosen payment option for the order. */ + paymentOption?: Maybe; + /** The pix information. */ + pix?: Maybe; + /** Current payment status. */ + status?: Maybe; + /** Order total value. */ + total?: Maybe; +}; + +export type OrderPaymentPixNode = { + /** The QR code. */ + qrCode?: Maybe; + /** The expiration date of the QR code. */ + qrCodeExpirationDate?: Maybe; + /** The image URL of the QR code. */ + qrCodeUrl?: Maybe; +}; + +export type OrderProductNode = { + /** List of adjusts on the product price, if any. */ + adjusts?: Maybe>>; + /** The product attributes. */ + attributes?: Maybe>>; + /** The cost of the customizations, if any. */ + customizationPrice: Scalars['Decimal']['output']; + /** List of customizations for the product. */ + customizations?: Maybe>>; + /** Amount of discount in the product price, if any. */ + discount: Scalars['Decimal']['output']; + /** If the product is a gift. */ + gift?: Maybe; + /** The product image. */ + image?: Maybe; + /** The product list price. */ + listPrice: Scalars['Decimal']['output']; + /** The product name. */ + name?: Maybe; + /** The cost of the packagings, if any. */ + packagingPrice: Scalars['Decimal']['output']; + /** List of packagings for the product. */ + packagings?: Maybe>>; + /** The product price. */ + price: Scalars['Decimal']['output']; + /** Information about the product seller. */ + productSeller?: Maybe; + /** Variant unique identifier. */ + productVariantId: Scalars['Long']['output']; + /** Quantity of the given product in the order. */ + quantity: Scalars['Long']['output']; + /** The product sale price. */ + salePrice: Scalars['Decimal']['output']; + /** The product SKU. */ + sku?: Maybe; + /** List of trackings for the order. */ + trackings?: Maybe>>; + /** Value of an unit of the product. */ + unitaryValue: Scalars['Decimal']['output']; +}; + +export type OrderSellerNode = { + /** The seller's name. */ + name?: Maybe; +}; + +export type OrderShippingNode = { + /** Limit date of delivery, in days. */ + deadline?: Maybe; + /** Deadline text message. */ + deadlineText?: Maybe; + /** Distribution center unique identifier. */ + distributionCenterId?: Maybe; + /** The order pick up unique identifier. */ + pickUpId?: Maybe; + /** The products belonging to the order. */ + products?: Maybe>>; + /** Amount discounted from shipping costs, if any. */ + promotion?: Maybe; + /** Shipping company connector identifier code. */ + refConnector?: Maybe; + /** Start date of shipping schedule. */ + scheduleFrom?: Maybe; + /** Limit date of shipping schedule. */ + scheduleUntil?: Maybe; + /** Shipping fee value. */ + shippingFee?: Maybe; + /** The shipping name. */ + shippingName?: Maybe; + /** Shipping rate table unique identifier. */ + shippingTableId?: Maybe; + /** The total value. */ + total?: Maybe; + /** Order package size. */ + volume?: Maybe; + /** The order weight, in grams. */ + weight?: Maybe; +}; + +export type OrderShippingProductNode = { + /** Distribution center unique identifier. */ + distributionCenterId?: Maybe; + /** The product price. */ + price?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; + /** Quantity of the given product. */ + quantity: Scalars['Int']['output']; +}; + +/** Define the sort orientation of the result set. */ +export type OrderSortDirection = + /** The results will be sorted in an ascending order. */ + | 'ASC' + /** The results will be sorted in an descending order. */ + | 'DESC'; + +/** Represents the status of an order. */ +export type OrderStatus = + /** Order has been approved in analysis. */ + | 'APPROVED_ANALYSIS' + /** Order has been authorized. */ + | 'AUTHORIZED' + /** Order is awaiting payment. */ + | 'AWAITING_PAYMENT' + /** Order is awaiting change of payment method. */ + | 'AWAITING_PAYMENT_CHANGE' + /** Order has been cancelled. */ + | 'CANCELLED' + /** Order has been cancelled - Card Denied. */ + | 'CANCELLED_DENIED_CARD' + /** Order has been cancelled - Fraud. */ + | 'CANCELLED_FRAUD' + /** Order has been cancelled. */ + | 'CANCELLED_ORDER_CANCELLED' + /** Order has been cancelled - Suspected Fraud. */ + | 'CANCELLED_SUSPECT_FRAUD' + /** Order has been cancelled - Card Temporarily Denied. */ + | 'CANCELLED_TEMPORARILY_DENIED_CARD' + /** Order has been checked. */ + | 'CHECKED_ORDER' + /** Order has been credited. */ + | 'CREDITED' + /** Order has been delivered. */ + | 'DELIVERED' + /** Payment denied, but the order has not been cancelled. */ + | 'DENIED_PAYMENT' + /** Documents needed for purchase. */ + | 'DOCUMENTS_FOR_PURCHASE' + /** Order has been placed. */ + | 'ORDERED' + /** Order has been paid. */ + | 'PAID' + /** Available for pick-up in store. */ + | 'PICK_UP_IN_STORE' + /** Order has been received - Gift Card. */ + | 'RECEIVED_GIFT_CARD' + /** Order has been returned. */ + | 'RETURNED' + /** Order has been sent. */ + | 'SENT' + /** Order has been sent - Invoiced. */ + | 'SENT_INVOICED' + /** Order has been separated. */ + | 'SEPARATED'; + +export type OrderStatusNode = { + /** The date when status has changed. */ + changeDate?: Maybe; + /** Order status. */ + status?: Maybe; + /** Status unique identifier. */ + statusId: Scalars['Long']['output']; +}; + +export type OrderTrackingNode = { + /** The tracking code. */ + code?: Maybe; + /** The URL for tracking. */ + url?: Maybe; +}; + +/** Information about pagination in a connection. */ +export type PageInfo = { + /** When paginating forwards, the cursor to continue. */ + endCursor?: Maybe; + /** Indicates whether more edges exist following the set defined by the clients arguments. */ + hasNextPage: Scalars['Boolean']['output']; + /** Indicates whether more edges exist prior the set defined by the clients arguments. */ + hasPreviousPage: Scalars['Boolean']['output']; + /** When paginating backwards, the cursor to continue. */ + startCursor?: Maybe; +}; + +/** Partners are used to assign specific products or price tables depending on its scope. */ +export type Partner = Node & { + /** The partner alias. */ + alias?: Maybe; + /** The partner is valid until this date. */ + endDate: Scalars['DateTime']['output']; + /** The full partner logo URL. */ + fullUrlLogo?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The partner logo's URL. */ + logoUrl?: Maybe; + /** The partner's name. */ + name?: Maybe; + /** The partner's origin. */ + origin?: Maybe; + /** The partner's access token. */ + partnerAccessToken?: Maybe; + /** Partner unique identifier. */ + partnerId: Scalars['Long']['output']; + /** Portfolio identifier assigned to this partner. */ + portfolioId: Scalars['Int']['output']; + /** Price table identifier assigned to this partner. */ + priceTableId: Scalars['Int']['output']; + /** The partner is valid from this date. */ + startDate: Scalars['DateTime']['output']; + /** The type of scoped the partner is used. */ + type?: Maybe; +}; + + +/** Partners are used to assign specific products or price tables depending on its scope. */ +export type PartnerFullUrlLogoArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +export type PartnerAccessToken = { + token?: Maybe; + validUntil?: Maybe; +}; + +/** The input to authenticate closed scope partners. */ +export type PartnerAccessTokenInput = { + password: Scalars['String']['input']; + username: Scalars['String']['input']; +}; + +/** Input for partners. */ +export type PartnerByRegionInput = { + /** CEP to get the regional partners. */ + cep?: InputMaybe; + /** Region ID to get the regional partners. */ + regionId?: InputMaybe; +}; + +/** Define the partner attribute which the result set will be sorted on. */ +export type PartnerSortKeys = + /** The partner unique identifier. */ + | 'ID' + /** The partner name. */ + | 'NAME'; + +export type PartnerSubtype = + /** Partner 'client' subtype. */ + | 'CLIENT' + /** Partner 'closed' subtype. */ + | 'CLOSED' + /** Partner 'open' subtype. */ + | 'OPEN'; + +/** A connection to a list of items. */ +export type PartnersConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; +}; + +/** An edge in a connection. */ +export type PartnersEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +/** Informations about the physical store. */ +export type PhysicalStore = { + /** Additional text. */ + additionalText?: Maybe; + /** Physical store address. */ + address?: Maybe; + /** Physical store address details. */ + addressDetails?: Maybe; + /** Physical store address number. */ + addressNumber?: Maybe; + /** Physical store address city. */ + city?: Maybe; + /** Physical store country. */ + country?: Maybe; + /** Physical store DDD. */ + ddd: Scalars['Int']['output']; + /** Delivery deadline. */ + deliveryDeadline: Scalars['Int']['output']; + /** Physical store email. */ + email?: Maybe; + /** Physical store latitude. */ + latitude?: Maybe; + /** Physical store longitude. */ + longitude?: Maybe; + /** Physical store name. */ + name?: Maybe; + /** Physical store address neighborhood. */ + neighborhood?: Maybe; + /** Physical store phone number. */ + phoneNumber?: Maybe; + /** Physical store ID. */ + physicalStoreId: Scalars['Int']['output']; + /** If the physical store allows pickup. */ + pickup: Scalars['Boolean']['output']; + /** Pickup deadline. */ + pickupDeadline: Scalars['Int']['output']; + /** Physical store state. */ + state?: Maybe; + /** Physical store zip code. */ + zipCode?: Maybe; +}; + +/** Range of prices for this product. */ +export type PriceRange = { + /** The quantity of products in this range. */ + quantity: Scalars['Int']['output']; + /** The price range. */ + range?: Maybe; +}; + +export type PriceTable = { + /** The amount of discount in percentage. */ + discountPercentage: Scalars['Decimal']['output']; + /** The id of this price table. */ + id: Scalars['Long']['output']; + /** The listed regular price of this table. */ + listPrice?: Maybe; + /** The current working price of this table. */ + price: Scalars['Decimal']['output']; +}; + +/** The prices of the product. */ +export type Prices = { + /** The best installment option available. */ + bestInstallment?: Maybe; + /** The amount of discount in percentage. */ + discountPercentage: Scalars['Decimal']['output']; + /** Wether the current price is discounted. */ + discounted: Scalars['Boolean']['output']; + /** List of the possibles installment plans. */ + installmentPlans?: Maybe>>; + /** The listed regular price of the product. */ + listPrice?: Maybe; + /** The multiplication factor used for items that are sold by quantity. */ + multiplicationFactor: Scalars['Float']['output']; + /** The current working price. */ + price: Scalars['Decimal']['output']; + /** + * List of the product different price tables. + * + * Only returned when using the partnerAccessToken or public price tables. + */ + priceTables?: Maybe>>; + /** Lists the different price options when buying the item over the given quantity. */ + wholesalePrices?: Maybe>>; +}; + +/** Input to specify the range of prices to return. */ +export type PricesInput = { + /** The product discount must be greater than or equal to. */ + discount_gte?: InputMaybe; + /** The product discount must be lesser than or equal to. */ + discount_lte?: InputMaybe; + /** Return only products where the listed price is more than the price. */ + discounted?: InputMaybe; + /** The product price must be greater than or equal to. */ + price_gte?: InputMaybe; + /** The product price must be lesser than or equal to. */ + price_lte?: InputMaybe; +}; + +/** A product represents an item for sale in the store. */ +export type Product = Node & { + /** Check if the product can be added to cart directly from spot. */ + addToCartFromSpot?: Maybe; + /** The product url alias. */ + alias?: Maybe; + /** List of the product attributes. */ + attributes?: Maybe>>; + /** Field to check if the product is available in stock. */ + available?: Maybe; + /** The product average rating. From 0 to 5. */ + averageRating?: Maybe; + /** BuyBox informations. */ + buyBox?: Maybe; + /** The product condition. */ + condition?: Maybe; + /** The product creation date. */ + createdAt?: Maybe; + /** The product delivery deadline. */ + deadline?: Maybe; + /** Check if the product should be displayed. */ + display?: Maybe; + /** Check if the product should be displayed only for partners. */ + displayOnlyPartner?: Maybe; + /** Check if the product should be displayed on search. */ + displaySearch?: Maybe; + /** The product's unique EAN. */ + ean?: Maybe; + /** Check if the product offers free shipping. */ + freeShipping?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** List of the product images. */ + images?: Maybe>>; + /** List of the product insformations. */ + informations?: Maybe>>; + /** Check if its the main variant. */ + mainVariant?: Maybe; + /** The product minimum quantity for an order. */ + minimumOrderQuantity?: Maybe; + /** Check if the product is a new release. */ + newRelease?: Maybe; + /** The number of votes that the average rating consists of. */ + numberOfVotes?: Maybe; + /** Parent product unique identifier. */ + parentId?: Maybe; + /** The product prices. */ + prices?: Maybe; + /** Summarized informations about the brand of the product. */ + productBrand?: Maybe; + /** Summarized informations about the categories of the product. */ + productCategories?: Maybe>>; + /** Product unique identifier. */ + productId?: Maybe; + /** The product name. */ + productName?: Maybe; + /** Summarized informations about the subscription of the product. */ + productSubscription?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; + /** List of promotions this product belongs to. */ + promotions?: Maybe>>; + /** The product seller. */ + seller?: Maybe; + /** List of similar products. */ + similarProducts?: Maybe>>; + /** The product's unique SKU. */ + sku?: Maybe; + /** The values of the spot attribute. */ + spotAttributes?: Maybe>>; + /** The product spot information. */ + spotInformation?: Maybe; + /** Check if the product is on spotlight. */ + spotlight?: Maybe; + /** The available stock at the default distribution center. */ + stock?: Maybe; + /** List of the product stocks on different distribution centers. */ + stocks?: Maybe>>; + /** List of subscription groups this product belongs to. */ + subscriptionGroups?: Maybe>>; + /** Check if the product is a telesale. */ + telesales?: Maybe; + /** The product last update date. */ + updatedAt?: Maybe; + /** The product video url. */ + urlVideo?: Maybe; + /** The variant name. */ + variantName?: Maybe; +}; + + +/** A product represents an item for sale in the store. */ +export type ProductImagesArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +export type ProductAggregations = { + /** List of product filters which can be used to filter subsequent queries. */ + filters?: Maybe>>; + /** Minimum price of the products. */ + maximumPrice: Scalars['Decimal']['output']; + /** Maximum price of the products. */ + minimumPrice: Scalars['Decimal']['output']; + /** List of price ranges for the selected products. */ + priceRanges?: Maybe>>; +}; + + +export type ProductAggregationsFiltersArgs = { + position?: InputMaybe; +}; + +/** The attributes of the product. */ +export type ProductAttribute = Node & { + /** The id of the attribute. */ + attributeId: Scalars['Long']['output']; + /** The display type of the attribute. */ + displayType?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The name of the attribute. */ + name?: Maybe; + /** The type of the attribute. */ + type?: Maybe; + /** The value of the attribute. */ + value?: Maybe; +}; + +export type ProductBrand = { + /** The hotsite url alias fot this brand. */ + alias?: Maybe; + /** The full brand logo URL. */ + fullUrlLogo?: Maybe; + /** The brand id. */ + id: Scalars['Long']['output']; + /** The url that contains the brand logo image. */ + logoUrl?: Maybe; + /** The name of the brand. */ + name?: Maybe; +}; + + +export type ProductBrandFullUrlLogoArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Information about the category of a product. */ +export type ProductCategory = { + /** Wether the category is currently active. */ + active: Scalars['Boolean']['output']; + /** The categories in google format. */ + googleCategories?: Maybe; + /** The category hierarchy. */ + hierarchy?: Maybe; + /** The id of the category. */ + id: Scalars['Int']['output']; + /** Wether this category is the main category for this product. */ + main: Scalars['Boolean']['output']; + /** The category name. */ + name?: Maybe; + /** The category hotsite url alias. */ + url?: Maybe; +}; + +export type ProductCollectionSegment = { + items?: Maybe>>; + page: Scalars['Int']['output']; + pageSize: Scalars['Int']['output']; + totalCount: Scalars['Int']['output']; +}; + +/** Filter product results based on giving attributes. */ +export type ProductExplicitFiltersInput = { + /** The set of attributes do filter. */ + attributes?: InputMaybe; + /** Choose if you want to retrieve only the available products in stock. */ + available?: InputMaybe; + /** The set of brand IDs which the result item brand ID must be included in. */ + brandId?: InputMaybe>; + /** The set of category IDs which the result item category ID must be included in. */ + categoryId?: InputMaybe>; + /** The set of EANs which the result item EAN must be included. */ + ean?: InputMaybe>>; + /** Retrieve the product variant only if it contains images. */ + hasImages?: InputMaybe; + /** Retrieve the product variant only if it is the main product variant. */ + mainVariant?: InputMaybe; + /** The set of prices to filter. */ + prices?: InputMaybe; + /** The product unique identifier (you may provide a list of IDs if needed). */ + productId?: InputMaybe>; + /** The product variant unique identifier (you may provide a list of IDs if needed). */ + productVariantId?: InputMaybe>; + /** A product ID or a list of IDs to search for other products with the same parent ID. */ + sameParentAs?: InputMaybe>; + /** The set of SKUs which the result item SKU must be included. */ + sku?: InputMaybe>>; + /** Show products with a quantity of available products in stock greater than or equal to the given number. */ + stock_gte?: InputMaybe; + /** Show products with a quantity of available products in stock less than or equal to the given number. */ + stock_lte?: InputMaybe; + /** The set of stocks to filter. */ + stocks?: InputMaybe; + /** Retrieve products which the last update date is greater than or equal to the given date. */ + updatedAt_gte?: InputMaybe; + /** Retrieve products which the last update date is less than or equal to the given date. */ + updatedAt_lte?: InputMaybe; +}; + +/** Custom attribute defined on store's admin may also be used as a filter. */ +export type ProductFilterInput = { + /** The attribute name. */ + field: Scalars['String']['input']; + /** The set of values which the result filter item value must be included in. */ + values: Array>; +}; + +/** Options available for the given product. */ +export type ProductOption = Node & { + /** A list of attributes available for the given product and its variants. */ + attributes?: Maybe>>; + /** A list of customizations available for the given products. */ + customizations?: Maybe>>; + /** The node unique identifier. */ + id?: Maybe; +}; + + +/** Options available for the given product. */ +export type ProductOptionAttributesArgs = { + filter?: InputMaybe>>; +}; + +/** A product price alert. */ +export type ProductPriceAlert = { + /** The alerted's email. */ + email?: Maybe; + /** The alerted's name. */ + name?: Maybe; + /** The price alert ID. */ + priceAlertId: Scalars['Long']['output']; + /** The product variant ID. */ + productVariantId: Scalars['Long']['output']; + /** The request date. */ + requestDate: Scalars['DateTime']['output']; + /** The target price. */ + targetPrice: Scalars['Decimal']['output']; +}; + +export type ProductRecommendationAlgorithm = + | 'DEFAULT'; + +/** Define the product attribute which the result set will be sorted on. */ +export type ProductSearchSortKeys = + /** The applied discount to the product variant price. */ + | 'DISCOUNT' + /** The product name. */ + | 'NAME' + /** The product variant price. */ + | 'PRICE' + /** Sort in a random way. */ + | 'RANDOM' + /** The date the product was released. */ + | 'RELEASE_DATE' + /** The relevance that the search engine gave to the possible result item based on own criteria. */ + | 'RELEVANCE' + /** The sales number on a period of time. */ + | 'SALES' + /** The quantity in stock of the product variant. */ + | 'STOCK'; + +/** Define the product attribute which the result set will be sorted on. */ +export type ProductSortKeys = + /** The applied discount to the product variant price. */ + | 'DISCOUNT' + /** The product name. */ + | 'NAME' + /** The product variant price. */ + | 'PRICE' + /** Sort in a random way. */ + | 'RANDOM' + /** The date the product was released. */ + | 'RELEASE_DATE' + /** The sales number on a period of time. */ + | 'SALES' + /** The quantity in stock of the product variant. */ + | 'STOCK'; + +export type ProductSubscription = { + /** The amount of discount if this product is sold as a subscription. */ + discount: Scalars['Decimal']['output']; + /** The price of the product when sold as a subscription. */ + price?: Maybe; + /** Wether this product is sold only as a subscrition. */ + subscriptionOnly: Scalars['Boolean']['output']; +}; + +/** Product variants that have the attribute. */ +export type ProductVariant = Node & { + /** The available stock at the default distribution center. */ + aggregatedStock?: Maybe; + /** The product alias. */ + alias?: Maybe; + /** List of the selected variant attributes. */ + attributes?: Maybe>>; + /** Field to check if the product is available in stock. */ + available?: Maybe; + /** The product's EAN. */ + ean?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** The product's images. */ + images?: Maybe>>; + /** The seller's product offers. */ + offers?: Maybe>>; + /** The product prices. */ + prices?: Maybe; + /** Product unique identifier. */ + productId?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; + /** Product variant name. */ + productVariantName?: Maybe; + /** List of promotions this product variant belongs to. */ + promotions?: Maybe>>; + /** The product's unique SKU. */ + sku?: Maybe; + /** The available stock at the default distribution center. */ + stock?: Maybe; +}; + + +/** Product variants that have the attribute. */ +export type ProductVariantImagesArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** A connection to a list of items. */ +export type ProductsConnection = { + /** A list of edges. */ + edges?: Maybe>; + /** A flattened list of the nodes. */ + nodes?: Maybe>>; + /** Information to aid in pagination. */ + pageInfo: PageInfo; + totalCount: Scalars['Int']['output']; +}; + +/** An edge in a connection. */ +export type ProductsEdge = { + /** A cursor for use in pagination. */ + cursor: Scalars['String']['output']; + /** The item at the end of the edge. */ + node?: Maybe; +}; + +/** Information about promotions of a product. */ +export type Promotion = { + /** The promotion html content. */ + content?: Maybe; + /** Where the promotion is shown (spot, product page, etc..). */ + disclosureType?: Maybe; + /** The stamp URL of the promotion. */ + fullStampUrl?: Maybe; + /** The promotion id. */ + id: Scalars['Long']['output']; + /** The stamp of the promotion. */ + stamp?: Maybe; + /** The promotion title. */ + title?: Maybe; +}; + + +/** Information about promotions of a product. */ +export type PromotionFullStampUrlArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +export type QueryRoot = { + /** Get informations about an address. */ + address?: Maybe; + /** Get query completion suggestion. */ + autocomplete?: Maybe; + /** List of banners. */ + banners?: Maybe; + /** List of brands */ + brands?: Maybe; + /** Retrieve a buylist by the given id. */ + buyList?: Maybe; + /** Prices informations */ + calculatePrices?: Maybe; + /** List of categories. */ + categories?: Maybe; + /** Get info from the checkout cart corresponding to the given ID. */ + checkout?: Maybe; + /** List of contents. */ + contents?: Maybe; + /** Get informations about a customer from the store. */ + customer?: Maybe; + /** Retrieve a single hotsite. A hotsite consists of products, banners and contents. */ + hotsite?: Maybe; + /** List of the shop's hotsites. A hotsite consists of products, banners and contents. */ + hotsites?: Maybe; + /** List of menu groups. */ + menuGroups?: Maybe>>; + /** Get newsletter information group fields. */ + newsletterInformationGroupFields?: Maybe>>; + node?: Maybe; + nodes?: Maybe>>; + /** Get single partner. */ + partner?: Maybe; + /** Get partner by region. */ + partnerByRegion?: Maybe; + /** List of partners. */ + partners?: Maybe; + /** Returns the available payment methods for a given cart ID */ + paymentMethods?: Maybe>>; + /** Retrieve a product by the given id. */ + product?: Maybe; + /** + * Options available for the given product. + * @deprecated Use the product query. + */ + productOptions?: Maybe; + /** Retrieve a list of recommended products by product id. */ + productRecommendations?: Maybe>>; + /** Retrieve a list of products by specific filters. */ + products?: Maybe; + /** Retrieve a list of scripts. */ + scripts?: Maybe>>; + /** Search products with cursor pagination. */ + search?: Maybe; + /** Get the shipping quotes by providing CEP and checkout or product identifier. */ + shippingQuotes?: Maybe>>; + /** Store informations */ + shop?: Maybe; + /** Store settings */ + shopSettings?: Maybe>>; + /** Get the URI kind. */ + uri?: Maybe; +}; + + +export type QueryRootAddressArgs = { + cep?: InputMaybe; +}; + + +export type QueryRootAutocompleteArgs = { + limit?: InputMaybe; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; +}; + + +export type QueryRootBannersArgs = { + after?: InputMaybe; + bannerIds?: InputMaybe>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: BannerSortKeys; +}; + + +export type QueryRootBrandsArgs = { + after?: InputMaybe; + before?: InputMaybe; + brandInput?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: BrandSortKeys; +}; + + +export type QueryRootBuyListArgs = { + id: Scalars['Long']['input']; + partnerAccessToken?: InputMaybe; +}; + + +export type QueryRootCalculatePricesArgs = { + partnerAccessToken?: InputMaybe; + products: Array>; +}; + + +export type QueryRootCategoriesArgs = { + after?: InputMaybe; + before?: InputMaybe; + categoryIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: CategorySortKeys; +}; + + +export type QueryRootCheckoutArgs = { + checkoutId: Scalars['String']['input']; + customerAccessToken?: InputMaybe; +}; + + +export type QueryRootContentsArgs = { + after?: InputMaybe; + before?: InputMaybe; + contentIds?: InputMaybe>; + first?: InputMaybe; + last?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: ContentSortKeys; +}; + + +export type QueryRootCustomerArgs = { + customerAccessToken?: InputMaybe; +}; + + +export type QueryRootHotsiteArgs = { + hotsiteId?: InputMaybe; + partnerAccessToken?: InputMaybe; + url?: InputMaybe; +}; + + +export type QueryRootHotsitesArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + hotsiteIds?: InputMaybe>; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: HotsiteSortKeys; +}; + + +export type QueryRootMenuGroupsArgs = { + partnerAccessToken?: InputMaybe; + position?: InputMaybe; + url: Scalars['String']['input']; +}; + + +export type QueryRootNodeArgs = { + id: Scalars['ID']['input']; +}; + + +export type QueryRootNodesArgs = { + ids: Array; +}; + + +export type QueryRootPartnerArgs = { + partnerAccessToken: Scalars['String']['input']; +}; + + +export type QueryRootPartnerByRegionArgs = { + input: PartnerByRegionInput; +}; + + +export type QueryRootPartnersArgs = { + after?: InputMaybe; + alias?: InputMaybe>>; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; + names?: InputMaybe>>; + priceTableIds?: InputMaybe>; + sortDirection?: SortDirection; + sortKey?: PartnerSortKeys; +}; + + +export type QueryRootPaymentMethodsArgs = { + checkoutId: Scalars['Uuid']['input']; +}; + + +export type QueryRootProductArgs = { + partnerAccessToken?: InputMaybe; + productId: Scalars['Long']['input']; +}; + + +export type QueryRootProductOptionsArgs = { + productId: Scalars['Long']['input']; +}; + + +export type QueryRootProductRecommendationsArgs = { + algorithm?: ProductRecommendationAlgorithm; + partnerAccessToken?: InputMaybe; + productId: Scalars['Long']['input']; + quantity?: Scalars['Int']['input']; +}; + + +export type QueryRootProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filters: ProductExplicitFiltersInput; + first?: InputMaybe; + last?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: SortDirection; + sortKey?: ProductSortKeys; +}; + + +export type QueryRootScriptsArgs = { + name?: InputMaybe; + pageType?: InputMaybe>; + position?: InputMaybe; + url?: InputMaybe; +}; + + +export type QueryRootSearchArgs = { + operation?: Operation; + partnerAccessToken?: InputMaybe; + query?: InputMaybe; +}; + + +export type QueryRootShippingQuotesArgs = { + cep?: InputMaybe; + checkoutId?: InputMaybe; + productVariantId?: InputMaybe; + quantity?: InputMaybe; + useSelectedAddress?: InputMaybe; +}; + + +export type QueryRootShopSettingsArgs = { + settingNames?: InputMaybe>>; +}; + + +export type QueryRootUriArgs = { + url: Scalars['String']['input']; +}; + +export type Question = { + answers?: Maybe>>; + question?: Maybe; + questionId?: Maybe; +}; + +/** Back in stock registration input parameters. */ +export type RestockAlertInput = { + /** Email to be notified. */ + email: Scalars['String']['input']; + /** Name of the person to be notified. */ + name?: InputMaybe; + /** The product variant id of the product to be notified. */ + productVariantId: Scalars['Long']['input']; +}; + +export type RestockAlertNode = { + /** Email to be notified. */ + email?: Maybe; + /** Name of the person to be notified. */ + name?: Maybe; + /** The product variant id. */ + productVariantId: Scalars['Long']['output']; + /** Date the alert was requested. */ + requestDate: Scalars['DateTime']['output']; +}; + +/** A product review written by a customer. */ +export type Review = { + /** The reviewer name. */ + customer?: Maybe; + /** The reviewer e-mail. */ + email?: Maybe; + /** The review rating. */ + rating: Scalars['Int']['output']; + /** The review content. */ + review?: Maybe; + /** The review date. */ + reviewDate: Scalars['DateTime']['output']; +}; + +/** Review input parameters. */ +export type ReviewCreateInput = { + /** The reviewer's email. */ + email: Scalars['String']['input']; + /** The reviewer's name. */ + name: Scalars['String']['input']; + /** The product variant id to add the review to. */ + productVariantId: Scalars['Long']['input']; + /** The review rating. */ + rating: Scalars['Int']['input']; + /** The google recaptcha token. */ + recaptchaToken?: InputMaybe; + /** The review content. */ + review: Scalars['String']['input']; +}; + +/** Entity SEO information. */ +export type Seo = { + /** Content of SEO. */ + content?: Maybe; + /** Equivalent SEO type for HTTP. */ + httpEquiv?: Maybe; + /** Name of SEO. */ + name?: Maybe; + /** Scheme for SEO. */ + scheme?: Maybe; + /** Type of SEO. */ + type?: Maybe; +}; + +/** Returns the scripts registered in the script manager. */ +export type Script = { + /** The script content. */ + content?: Maybe; + /** The script name. */ + name?: Maybe; + /** The script page type. */ + pageType: ScriptPageType; + /** The script position. */ + position: ScriptPosition; + /** The script priority. */ + priority: Scalars['Int']['output']; +}; + +export type ScriptPageType = + | 'ALL' + | 'BRAND' + | 'CATEGORY' + | 'HOME' + | 'PRODUCT' + | 'SEARCH'; + +export type ScriptPosition = + | 'BODY_END' + | 'BODY_START' + | 'FOOTER_END' + | 'FOOTER_START' + | 'HEADER_END' + | 'HEADER_START'; + +/** Search for relevant products to the searched term. */ +export type Search = { + /** Aggregations from the products. */ + aggregations?: Maybe; + /** A list of banners displayed in search pages. */ + banners?: Maybe>>; + /** List of search breadcrumbs. */ + breadcrumbs?: Maybe>>; + /** A list of contents displayed in search pages. */ + contents?: Maybe>>; + /** Information about forbidden term. */ + forbiddenTerm?: Maybe; + /** The quantity of products displayed per page. */ + pageSize: Scalars['Int']['output']; + /** A cursor based paginated list of products from the search. */ + products?: Maybe; + /** An offset based paginated list of products from the search. */ + productsByOffset?: Maybe; + /** Redirection url in case a term in the search triggers a redirect. */ + redirectUrl?: Maybe; + /** Time taken to perform the search. */ + searchTime?: Maybe; +}; + + +/** Search for relevant products to the searched term. */ +export type SearchProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filters?: InputMaybe>>; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** Search for relevant products to the searched term. */ +export type SearchProductsByOffsetArgs = { + filters?: InputMaybe>>; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** Aggregated filters of a list of products. */ +export type SearchFilter = { + /** The name of the field. */ + field?: Maybe; + /** The origin of the field. */ + origin?: Maybe; + /** List of the values of the field. */ + values?: Maybe>>; +}; + +/** Details of a filter value. */ +export type SearchFilterItem = { + /** The name of the value. */ + name?: Maybe; + /** The quantity of product with this value. */ + quantity: Scalars['Int']['output']; +}; + +/** The response data */ +export type SearchRecord = { + /** The date time of the processed request */ + date: Scalars['DateTime']['output']; + /** If the record was successful */ + isSuccess: Scalars['Boolean']['output']; + /** The searched query */ + query?: Maybe; +}; + +/** The information to be saved for reports. */ +export type SearchRecordInput = { + /** The search operation (And, Or) */ + operation?: InputMaybe; + /** The current page */ + page: Scalars['Int']['input']; + /** How many products show in page */ + pageSize: Scalars['Int']['input']; + /** The client search page url */ + pageUrl?: InputMaybe; + /** The user search query */ + query?: InputMaybe; + /** How many products the search returned */ + totalResults: Scalars['Int']['input']; +}; + +/** The selected payment method details. */ +export type SelectedPaymentMethod = { + /** The unique identifier for the selected payment method. */ + id: Scalars['Uuid']['output']; + /** The list of installments associated with the selected payment method. */ + installments?: Maybe>>; + /** The selected installment. */ + selectedInstallment?: Maybe; +}; + +/** Details of an installment of the selected payment method. */ +export type SelectedPaymentMethodInstallment = { + /** The adjustment value applied to the installment. */ + adjustment: Scalars['Float']['output']; + /** The installment number. */ + number: Scalars['Int']['output']; + /** The total value of the installment. */ + total: Scalars['Float']['output']; + /** The individual value of each installment. */ + value: Scalars['Float']['output']; +}; + +/** Seller informations. */ +export type Seller = { + /** Seller name */ + name?: Maybe; +}; + +export type SellerInstallment = { + /** Wether the installment has discount. */ + discount: Scalars['Boolean']['output']; + /** Wether the installment has fees. */ + fees: Scalars['Boolean']['output']; + /** The number of installments. */ + number: Scalars['Int']['output']; + /** The value of the installment. */ + value: Scalars['Decimal']['output']; +}; + +export type SellerInstallmentPlan = { + /** The custom display name of this installment plan. */ + displayName?: Maybe; + /** List of the installments. */ + installments?: Maybe>>; +}; + +/** The seller's product offer */ +export type SellerOffer = { + name?: Maybe; + /** The product prices. */ + prices?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; +}; + +/** The prices of the product. */ +export type SellerPrices = { + /** List of the possibles installment plans. */ + installmentPlans?: Maybe>>; + /** The listed regular price of the product. */ + listPrice?: Maybe; + /** The current working price. */ + price?: Maybe; +}; + +export type ShippingNode = { + /** The shipping deadline. */ + deadline: Scalars['Int']['output']; + /** The delivery schedule detail. */ + deliverySchedule?: Maybe; + /** The shipping name. */ + name?: Maybe; + /** The shipping quote unique identifier. */ + shippingQuoteId: Scalars['Uuid']['output']; + /** The shipping type. */ + type?: Maybe; + /** The shipping value. */ + value: Scalars['Float']['output']; +}; + +/** The product informations related to the shipping. */ +export type ShippingProduct = { + /** The product unique identifier. */ + productVariantId: Scalars['Int']['output']; + /** The shipping value related to the product. */ + value: Scalars['Float']['output']; +}; + +/** A shipping quote. */ +export type ShippingQuote = Node & { + /** The shipping deadline. */ + deadline: Scalars['Int']['output']; + /** The available time slots for scheduling the delivery of the shipping quote. */ + deliverySchedules?: Maybe>>; + /** The node unique identifier. */ + id?: Maybe; + /** The shipping name. */ + name?: Maybe; + /** The products related to the shipping. */ + products?: Maybe>>; + /** The shipping quote unique identifier. */ + shippingQuoteId: Scalars['Uuid']['output']; + /** The shipping type. */ + type?: Maybe; + /** The shipping value. */ + value: Scalars['Float']['output']; +}; + +/** Informations about the store. */ +export type Shop = { + /** Checkout URL */ + checkoutUrl?: Maybe; + /** Store main URL */ + mainUrl?: Maybe; + /** Mobile checkout URL */ + mobileCheckoutUrl?: Maybe; + /** Mobile URL */ + mobileUrl?: Maybe; + /** Store modified name */ + modifiedName?: Maybe; + /** Store name */ + name?: Maybe; + /** Physical stores */ + physicalStores?: Maybe>>; +}; + +/** Store setting. */ +export type ShopSetting = { + /** Setting name */ + name?: Maybe; + /** Setting value */ + value?: Maybe; +}; + +/** Information about a similar product. */ +export type SimilarProduct = { + /** The url alias of this similar product. */ + alias?: Maybe; + /** The file name of the similar product image. */ + image?: Maybe; + /** The URL of the similar product image. */ + imageUrl?: Maybe; + /** The name of the similar product. */ + name?: Maybe; +}; + + +/** Information about a similar product. */ +export type SimilarProductImageUrlArgs = { + h?: InputMaybe; + w?: InputMaybe; +}; + +export type SimpleLogin = { + /** The customer access token */ + customerAccessToken?: Maybe; + /** The simple login question to answer */ + question?: Maybe; + /** The simple login type */ + type: SimpleLoginType; +}; + +/** The simple login type. */ +export type SimpleLoginType = + | 'NEW' + | 'SIMPLE'; + +/** A hotsite is a group of products used to organize them or to make them easier to browse. */ +export type SingleHotsite = Node & { + /** Aggregations from the products. */ + aggregations?: Maybe; + /** A list of banners associated with the hotsite. */ + banners?: Maybe>>; + /** A list of breadcrumbs for the hotsite. */ + breadcrumbs?: Maybe>>; + /** A list of contents associated with the hotsite. */ + contents?: Maybe>>; + /** The hotsite will be displayed until this date. */ + endDate?: Maybe; + /** Expression used to associate products to the hotsite. */ + expression?: Maybe; + /** Hotsite unique identifier. */ + hotsiteId: Scalars['Long']['output']; + /** The node unique identifier. */ + id?: Maybe; + /** The hotsite's name. */ + name?: Maybe; + /** Set the quantity of products displayed per page. */ + pageSize: Scalars['Int']['output']; + /** A list of products associated with the hotsite. Cursor pagination. */ + products?: Maybe; + /** A list of products associated with the hotsite. Offset pagination. */ + productsByOffset?: Maybe; + /** A list of SEO contents associated with the hotsite. */ + seo?: Maybe>>; + /** Sorting information to be used by default on the hotsite. */ + sorting?: Maybe; + /** The hotsite will be displayed from this date. */ + startDate?: Maybe; + /** The subtype of the hotsite. */ + subtype?: Maybe; + /** The template used for the hotsite. */ + template?: Maybe; + /** The hotsite's URL. */ + url?: Maybe; +}; + + +/** A hotsite is a group of products used to organize them or to make them easier to browse. */ +export type SingleHotsiteProductsArgs = { + after?: InputMaybe; + before?: InputMaybe; + filters?: InputMaybe>>; + first?: InputMaybe; + last?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + + +/** A hotsite is a group of products used to organize them or to make them easier to browse. */ +export type SingleHotsiteProductsByOffsetArgs = { + filters?: InputMaybe>>; + limit?: InputMaybe; + maximumPrice?: InputMaybe; + minimumPrice?: InputMaybe; + offset?: InputMaybe; + onlyMainVariant?: InputMaybe; + partnerAccessToken?: InputMaybe; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; +}; + +/** A product represents an item for sale in the store. */ +export type SingleProduct = Node & { + /** Check if the product can be added to cart directly from spot. */ + addToCartFromSpot?: Maybe; + /** The product url alias. */ + alias?: Maybe; + /** Information about the possible selection attributes. */ + attributeSelections?: Maybe; + /** List of the product attributes. */ + attributes?: Maybe>>; + /** Field to check if the product is available in stock. */ + available?: Maybe; + /** The product average rating. From 0 to 5. */ + averageRating?: Maybe; + /** List of product breadcrumbs. */ + breadcrumbs?: Maybe>>; + /** BuyBox informations. */ + buyBox?: Maybe; + /** Buy together products. */ + buyTogether?: Maybe>>; + /** The product condition. */ + condition?: Maybe; + /** The product creation date. */ + createdAt?: Maybe; + /** A list of customizations available for the given products. */ + customizations?: Maybe>>; + /** The product delivery deadline. */ + deadline?: Maybe; + /** Check if the product should be displayed. */ + display?: Maybe; + /** Check if the product should be displayed only for partners. */ + displayOnlyPartner?: Maybe; + /** Check if the product should be displayed on search. */ + displaySearch?: Maybe; + /** The product's unique EAN. */ + ean?: Maybe; + /** Check if the product offers free shipping. */ + freeShipping?: Maybe; + /** The node unique identifier. */ + id?: Maybe; + /** List of the product images. */ + images?: Maybe>>; + /** List of the product insformations. */ + informations?: Maybe>>; + /** Check if its the main variant. */ + mainVariant?: Maybe; + /** The product minimum quantity for an order. */ + minimumOrderQuantity?: Maybe; + /** Check if the product is a new release. */ + newRelease?: Maybe; + /** The number of votes that the average rating consists of. */ + numberOfVotes?: Maybe; + /** Product parallel options information. */ + parallelOptions?: Maybe>>; + /** Parent product unique identifier. */ + parentId?: Maybe; + /** The product prices. */ + prices?: Maybe; + /** Summarized informations about the brand of the product. */ + productBrand?: Maybe; + /** Summarized informations about the categories of the product. */ + productCategories?: Maybe>>; + /** Product unique identifier. */ + productId?: Maybe; + /** The product name. */ + productName?: Maybe; + /** Summarized informations about the subscription of the product. */ + productSubscription?: Maybe; + /** Variant unique identifier. */ + productVariantId?: Maybe; + /** List of promotions this product belongs to. */ + promotions?: Maybe>>; + /** List of customer reviews for this product. */ + reviews?: Maybe>>; + /** The product seller. */ + seller?: Maybe; + /** Product SEO informations. */ + seo?: Maybe>>; + /** List of similar products. */ + similarProducts?: Maybe>>; + /** The product's unique SKU. */ + sku?: Maybe; + /** The values of the spot attribute. */ + spotAttributes?: Maybe>>; + /** The product spot information. */ + spotInformation?: Maybe; + /** Check if the product is on spotlight. */ + spotlight?: Maybe; + /** The available stock at the default distribution center. */ + stock?: Maybe; + /** List of the product stocks on different distribution centers. */ + stocks?: Maybe>>; + /** List of subscription groups this product belongs to. */ + subscriptionGroups?: Maybe>>; + /** Check if the product is a telesale. */ + telesales?: Maybe; + /** The product last update date. */ + updatedAt?: Maybe; + /** The product video url. */ + urlVideo?: Maybe; + /** The variant name. */ + variantName?: Maybe; +}; + + +/** A product represents an item for sale in the store. */ +export type SingleProductAttributeSelectionsArgs = { + selected?: InputMaybe>>; +}; + + +/** A product represents an item for sale in the store. */ +export type SingleProductImagesArgs = { + height?: InputMaybe; + width?: InputMaybe; +}; + +/** Define the sort orientation of the result set. */ +export type SortDirection = + /** The results will be sorted in an ascending order. */ + | 'ASC' + /** The results will be sorted in an descending order. */ + | 'DESC'; + +/** Information about a product stock in a particular distribution center. */ +export type Stock = { + /** The id of the distribution center. */ + id: Scalars['Long']['output']; + /** The number of physical items in stock at this DC. */ + items: Scalars['Long']['output']; + /** The name of the distribution center. */ + name?: Maybe; +}; + +/** Input to specify the range of stocks, distribution center ID, and distribution center name to return. */ +export type StocksInput = { + /** The distribution center Ids to match. */ + dcId?: InputMaybe>; + /** The distribution center names to match. */ + dcName?: InputMaybe>>; + /** The product stock must be greater than or equal to. */ + stock_gte?: InputMaybe; + /** The product stock must be lesser than or equal to. */ + stock_lte?: InputMaybe; +}; + +export type SubscriptionGroup = { + /** The recurring types for this subscription group. */ + recurringTypes?: Maybe>>; + /** The status name of the group. */ + status?: Maybe; + /** The status id of the group. */ + statusId: Scalars['Int']['output']; + /** The subscription group id. */ + subscriptionGroupId: Scalars['Long']['output']; + /** Wether the product is only avaible for subscription. */ + subscriptionOnly: Scalars['Boolean']['output']; +}; + +export type SubscriptionRecurringType = { + /** The number of days of the recurring type. */ + days: Scalars['Int']['output']; + /** The recurring type display name. */ + name?: Maybe; + /** The recurring type id. */ + recurringTypeId: Scalars['Long']['output']; +}; + +export type UpdateCustomerAddressInput = { + addressDetails?: InputMaybe; + addressNumber?: InputMaybe; + cep?: InputMaybe; + city?: InputMaybe; + country?: InputMaybe; + email?: InputMaybe; + name?: InputMaybe; + neighborhood?: InputMaybe; + phone?: InputMaybe; + referencePoint?: InputMaybe; + state?: InputMaybe; + street?: InputMaybe; +}; + +/** Node of URI Kind. */ +export type Uri = { + /** The origin of the hotsite. */ + hotsiteSubtype?: Maybe; + /** Path kind. */ + kind: UriKind; + /** The partner subtype. */ + partnerSubtype?: Maybe; + /** Product alias. */ + productAlias?: Maybe; + /** Product categories IDs. */ + productCategoriesIds?: Maybe>; + /** Redirect status code. */ + redirectCode?: Maybe; + /** Url to redirect. */ + redirectUrl?: Maybe; +}; + +export type UriKind = + | 'BUY_LIST' + | 'HOTSITE' + | 'NOT_FOUND' + | 'PARTNER' + | 'PRODUCT' + | 'REDIRECT'; + +export type WholesalePrices = { + /** The wholesale price. */ + price: Scalars['Decimal']['output']; + /** The minimum quantity required for the wholesale price to be applied */ + quantity: Scalars['Int']['output']; +}; + +/** A representation of available time slots for scheduling a delivery. */ +export type DeliverySchedule = { + /** The date of the delivery schedule. */ + date: Scalars['DateTime']['output']; + /** The list of time periods available for scheduling a delivery. */ + periods?: Maybe>>; +}; + +/** Informations about a forbidden search term. */ +export type ForbiddenTerm = { + /** The suggested search term instead. */ + suggested?: Maybe; + /** The text to display about the term. */ + text?: Maybe; +}; + +export type Order = { + /** The coupon for discounts. */ + coupon?: Maybe; + /** Current account value used for the order. */ + currentAccount: Scalars['Decimal']['output']; + /** The date when te order was placed. */ + date: Scalars['DateTime']['output']; + /** The address where the order will be delivered. */ + deliveryAddress?: Maybe; + /** Order discount amount, if any. */ + discount: Scalars['Decimal']['output']; + /** Order interest fee, if any. */ + interestFee: Scalars['Decimal']['output']; + /** Information about order invoices. */ + invoices?: Maybe>>; + /** Information about order notes. */ + notes?: Maybe>>; + /** Order unique identifier. */ + orderId: Scalars['Long']['output']; + /** The date when the order was payed. */ + paymentDate?: Maybe; + /** Information about payments. */ + payments?: Maybe>>; + /** Products belonging to the order. */ + products?: Maybe>>; + /** List of promotions applied to the order. */ + promotions?: Maybe>; + /** The shipping fee. */ + shippingFee: Scalars['Decimal']['output']; + /** Information about order shippings. */ + shippings?: Maybe>>; + /** The order current status. */ + status?: Maybe; + /** List of the order status history. */ + statusHistory?: Maybe>>; + /** Order subtotal value. */ + subtotal: Scalars['Decimal']['output']; + /** Order total value. */ + total: Scalars['Decimal']['output']; + /** Information about order trackings. */ + trackings?: Maybe>>; +}; + +export type PaymentMethod = Node & { + /** The node unique identifier. */ + id?: Maybe; + /** The url link that displays for the payment. */ + imageUrl?: Maybe; + /** The name of the payment method. */ + name?: Maybe; +}; + +/** Represents a time period available for scheduling a delivery. */ +export type Period = { + /** The end time of the time period. */ + end?: Maybe; + /** The unique identifier of the time period. */ + id: Scalars['Long']['output']; + /** The start time of the time period. */ + start?: Maybe; +}; + +export type Wishlist = { + /** Wishlist products. */ + products?: Maybe>>; +}; + +export type AddCouponMutationVariables = Exact<{ + checkoutId: Scalars['Uuid']['input']; + coupon: Scalars['String']['input']; +}>; + + +export type AddCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type AddItemToCartMutationVariables = Exact<{ + input: CheckoutProductInput; +}>; + + +export type AddItemToCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type RemoveCouponMutationVariables = Exact<{ + checkoutId: Scalars['Uuid']['input']; +}>; + + +export type RemoveCouponMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type RemoveItemFromCartMutationVariables = Exact<{ + input: CheckoutProductInput; +}>; + + +export type RemoveItemFromCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type GetCartQueryVariables = Exact<{ + checkoutId: Scalars['String']['input']; +}>; + + +export type GetCartQuery = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type CreateCartMutationVariables = Exact<{ [key: string]: never; }>; + + +export type CreateCartMutation = { checkout?: { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null } | null }; + +export type GetProductQueryVariables = Exact<{ + productId: Scalars['Long']['input']; +}>; + + +export type GetProductQuery = { product?: { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null } | null }; + +export type GetProductsQueryVariables = Exact<{ + filters: ProductExplicitFiltersInput; + first: Scalars['Int']['input']; + sortDirection: SortDirection; + sortKey?: InputMaybe; +}>; + + +export type GetProductsQuery = { products?: { nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null } | null }; + +export type SearchQueryVariables = Exact<{ + operation: Operation; + query?: InputMaybe; + first: Scalars['Int']['input']; + sortDirection?: InputMaybe; + sortKey?: InputMaybe; + filters?: InputMaybe> | InputMaybe>; +}>; + + +export type SearchQuery = { search?: { pageSize: number, redirectUrl?: string | null, searchTime?: string | null, aggregations?: { filters?: Array<{ field?: string | null, origin?: string | null, values?: Array<{ quantity: number, name?: string | null } | null> | null } | null> | null } | null, breadcrumbs?: Array<{ link?: string | null, text?: string | null } | null> | null, forbiddenTerm?: { text?: string | null, suggested?: string | null } | null, products?: { totalCount: number, nodes?: Array<{ mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null } | null> | null, pageInfo: { hasNextPage: boolean, hasPreviousPage: boolean } } | null } | null }; + +export type CheckoutFragment = { checkoutId: any, shippingFee: any, subtotal: any, total: any, completed: boolean, coupon?: string | null, products?: Array<{ imageUrl?: string | null, brand?: string | null, ajustedPrice: any, listPrice: any, price: any, name?: string | null, productId: any, productVariantId: any, quantity: number, sku?: string | null, url?: string | null } | null> | null }; + +export type ProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, seller?: { name?: string | null } | null }; + +export type SingleProductFragment = { mainVariant?: boolean | null, productName?: string | null, productId?: any | null, alias?: string | null, available?: boolean | null, averageRating?: number | null, condition?: string | null, createdAt?: any | null, ean?: string | null, id?: string | null, minimumOrderQuantity?: number | null, productVariantId?: any | null, sku?: string | null, stock?: any | null, variantName?: string | null, attributes?: Array<{ value?: string | null, name?: string | null } | null> | null, productCategories?: Array<{ name?: string | null, url?: string | null, hierarchy?: string | null, main: boolean, googleCategories?: string | null } | null> | null, informations?: Array<{ title?: string | null, value?: string | null, type?: string | null } | null> | null, breadcrumbs?: Array<{ text?: string | null, link?: string | null } | null> | null, images?: Array<{ url?: string | null, fileName?: string | null, print: boolean } | null> | null, prices?: { discountPercentage: any, discounted: boolean, listPrice?: any | null, multiplicationFactor: number, price: any, bestInstallment?: { discount: boolean, displayName?: string | null, fees: boolean, name?: string | null, number: number, value: any } | null, installmentPlans?: Array<{ displayName?: string | null, name?: string | null, installments?: Array<{ discount: boolean, fees: boolean, number: number, value: any } | null> | null } | null> | null, priceTables?: Array<{ discountPercentage: any, id: any, listPrice?: any | null, price: any } | null> | null, wholesalePrices?: Array<{ price: any, quantity: number } | null> | null } | null, productBrand?: { fullUrlLogo?: string | null, logoUrl?: string | null, name?: string | null, alias?: string | null } | null, reviews?: Array<{ rating: number, review?: string | null, reviewDate: any, email?: string | null, customer?: string | null } | null> | null, seller?: { name?: string | null } | null, seo?: Array<{ name?: string | null, scheme?: string | null, type?: string | null, httpEquiv?: string | null, content?: string | null } | null> | null }; diff --git a/wake/utils/graphql/instropection.graphql.json b/wake/utils/graphql/instropection.graphql.json new file mode 100644 index 000000000..30fdf1822 --- /dev/null +++ b/wake/utils/graphql/instropection.graphql.json @@ -0,0 +1,23347 @@ +{ + "data": { + "__schema": { + "queryType": { + "name": "QueryRoot" + }, + "mutationType": { + "name": "Mutation" + }, + "subscriptionType": null, + "types": [ + { + "kind": "OBJECT", + "name": "__Directive", + "description": "A Directive provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.\n\nIn some cases, you need to provide options to alter GraphQL\u0027s execution behavior in ways field arguments will not suffice, such as conditionally including or skipping a field. Directives provide this by describing additional information to the executor.", + "fields": [ + { + "name": "args", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isRepeatable", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "locations", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__DirectiveLocation", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "onField", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use \u0060locations\u0060." + }, + { + "name": "onFragment", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use \u0060locations\u0060." + }, + { + "name": "onOperation", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": true, + "deprecationReason": "Use \u0060locations\u0060." + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__DirectiveLocation", + "description": "A Directive can be adjacent to many parts of the GraphQL language, a __DirectiveLocation describes one such possible adjacencies.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "QUERY", + "description": "Location adjacent to a query operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MUTATION", + "description": "Location adjacent to a mutation operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SUBSCRIPTION", + "description": "Location adjacent to a subscription operation.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD", + "description": "Location adjacent to a field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_DEFINITION", + "description": "Location adjacent to a fragment definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FRAGMENT_SPREAD", + "description": "Location adjacent to a fragment spread.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INLINE_FRAGMENT", + "description": "Location adjacent to an inline fragment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "VARIABLE_DEFINITION", + "description": "Location adjacent to a variable definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCHEMA", + "description": "Location adjacent to a schema definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SCALAR", + "description": "Location adjacent to a scalar definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Location adjacent to an object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FIELD_DEFINITION", + "description": "Location adjacent to a field definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ARGUMENT_DEFINITION", + "description": "Location adjacent to an argument definition", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Location adjacent to an interface definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Location adjacent to a union definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Location adjacent to an enum definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM_VALUE", + "description": "Location adjacent to an enum value definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Location adjacent to an input object type definition.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_FIELD_DEFINITION", + "description": "Location adjacent to an input object field definition.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__EnumValue", + "description": "One possible value for a given Enum. Enum values are unique values, not a placeholder for a string or numeric value. However an Enum value is returned in a JSON response as a string.", + "fields": [ + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Field", + "description": "Object and Interface types are described by a list of Fields, each of which has a name, potentially a list of arguments, and a return type.", + "fields": [ + { + "name": "args", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deprecationReason", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isDeprecated", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__InputValue", + "description": "Arguments provided to Fields or Directives and the input fields of an InputObject are represented as Input Values which describe their type and optionally a default value.", + "fields": [ + { + "name": "defaultValue", + "description": "A GraphQL-formatted string representing the default value for this input value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Schema", + "description": "A GraphQL Schema defines the capabilities of a GraphQL server. It exposes all available types and directives on the server, as well as the entry points for query, mutation, and subscription operations.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "directives", + "description": "A list of all directives supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Directive", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mutationType", + "description": "If this server supports mutation, the type that mutation operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "queryType", + "description": "The type that query operations will be rooted at.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionType", + "description": "If this server support subscription, the type that subscription operations will be rooted at.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "types", + "description": "A list of all types supported by this server.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "__Type", + "description": "The fundamental unit of any GraphQL Schema is the type. There are many kinds of types in GraphQL as represented by the \u0060__TypeKind\u0060 enum.\n\nDepending on the kind of a type, certain fields describe information about that type. Scalar types provide no information beyond a name and description, while Enum types provide their values. Object and Interface types provide the fields they describe. Abstract types, Union and Interface, provide the Object types possible at runtime. List and NonNull types compose other types.", + "fields": [ + { + "name": "description", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "enumValues", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__EnumValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": null, + "args": [ + { + "name": "includeDeprecated", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "false" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Field", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "inputFields", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__InputValue", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interfaces", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "__TypeKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ofType", + "description": null, + "args": [], + "type": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "possibleTypes", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "__Type", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "specifiedByURL", + "description": "\u0060specifiedByURL\u0060 may return a String (in the form of a URL) for custom scalars, otherwise it will return \u0060null\u0060.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "__TypeKind", + "description": "An enum describing what kind of type a given \u0060__Type\u0060 is.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "SCALAR", + "description": "Indicates this type is a scalar.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OBJECT", + "description": "Indicates this type is an object. \u0060fields\u0060 and \u0060interfaces\u0060 are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERFACE", + "description": "Indicates this type is an interface. \u0060fields\u0060 and \u0060possibleTypes\u0060 are valid fields.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNION", + "description": "Indicates this type is a union. \u0060possibleTypes\u0060 is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ENUM", + "description": "Indicates this type is an enum. \u0060enumValues\u0060 is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INPUT_OBJECT", + "description": "Indicates this type is an input object. \u0060inputFields\u0060 is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LIST", + "description": "Indicates this type is a list. \u0060ofType\u0060 is a valid field.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NON_NULL", + "description": "Indicates this type is a non-null. \u0060ofType\u0060 is a valid field.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Uuid", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Checkout", + "description": null, + "fields": [ + { + "name": "cep", + "description": "The CEP.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutId", + "description": "The checkout unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "completed", + "description": "Indicates if the checkout is completed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "coupon", + "description": "The coupon for discounts.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "The customer associated with the checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutCustomer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "login", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metadata", + "description": "The metadata related to this checkout.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metadata", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "The checkout orders informations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutOrder", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A list of products associated with the checkout.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProductNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedAddress", + "description": "The selected delivery address for the checkout.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedPaymentMethod", + "description": "The selected payment method", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedPaymentMethod", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedShipping", + "description": "Selected Shipping.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ShippingNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingFee", + "description": "The shipping fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The subtotal value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateDate", + "description": "The last update date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "Url for the current checkout id.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrder", + "description": "Represents a node in the checkout order.", + "fields": [ + { + "name": "adjustments", + "description": "The list of adjustments applied to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutOrderAdjustment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date", + "description": "The date of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "delivery", + "description": "Details of the delivery or store pickup.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutOrderDelivery", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountValue", + "description": "The discount value of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "dispatchTimeText", + "description": "The dispatch time text from the shop settings.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interestValue", + "description": "The interest value of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderId", + "description": "The ID of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderStatus", + "description": "The order status.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "OrderStatus", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payment", + "description": "The payment information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutOrderPayment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The list of products in the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutOrderProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingValue", + "description": "The shipping value of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalValue", + "description": "The total value of the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingNode", + "description": null, + "fields": [ + { + "name": "deadline", + "description": "The shipping deadline.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliverySchedule", + "description": "The delivery schedule detail.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "DeliveryScheduleDetail", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The shipping name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingQuoteId", + "description": "The shipping quote unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The shipping type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The shipping value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "description": "A customer from the store.", + "fields": [ + { + "name": "addresses", + "description": "Customer\u0027s addresses.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "birthDate", + "description": "Customer\u0027s birth date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "businessPhoneNumber", + "description": "Customer\u0027s business phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cnpj", + "description": "Taxpayer identification number for businesses.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "companyName", + "description": "Entities legal name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cpf", + "description": "Brazilian individual taxpayer registry identification.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creationDate", + "description": "Creation Date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerId", + "description": "Customer\u0027s unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerName", + "description": "Customer\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerType", + "description": "Indicates if it is a natural person or company profile.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryAddress", + "description": "Customer\u0027s delivery address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "Customer\u0027s email address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gender", + "description": "Customer\u0027s gender.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "informationGroups", + "description": "Customer information groups.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerInformationGroupNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mobilePhoneNumber", + "description": "Customer\u0027s mobile phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orders", + "description": "List of orders placed by the customer.", + "args": [ + { + "name": "offset", + "description": "The offset used to paginate.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "0" + }, + { + "name": "sortDirection", + "description": "Define the sort orientation of the result set.", + "type": { + "kind": "ENUM", + "name": "OrderSortDirection", + "ofType": null + }, + "defaultValue": "DESC" + }, + { + "name": "sortKey", + "description": "Define the order attribute which the result set will be sorted on.", + "type": { + "kind": "ENUM", + "name": "CustomerOrderSortKeys", + "ofType": null + }, + "defaultValue": "DATE" + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOrderCollectionSegment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ordersStatistics", + "description": "Statistics about the orders the customer made in a specific timeframe.", + "args": [ + { + "name": "dateGte", + "description": "Filter que customer orders by date greater than or equal the specified date.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "dateLt", + "description": "Filter que customer orders by date lesser than the specified date.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "onlyPaidOrders", + "description": "Toggle to apply the statistics only on orders with paid status.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "true" + }, + { + "name": "partnerId", + "description": "The partner id which the order was made with.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerOrdersStatistics", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partners", + "description": "Get info about the associated partners.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerPartnerNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "Customer\u0027s phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "residentialAddress", + "description": "Customer\u0027s residential address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "responsibleName", + "description": "Responsible\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rg", + "description": "Registration number Id.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stateRegistration", + "description": "State registration number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateDate", + "description": "Date of the last update.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlist", + "description": "Customer wishlist.", + "args": [ + { + "name": "productsIds", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "wishlist", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Hotsite", + "description": "A hotsite is a group of products used to organize them or to make them easier to browse.", + "fields": [ + { + "name": "banners", + "description": "A list of banners associated with the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contents", + "description": "A list of contents associated with the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Content", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endDate", + "description": "The hotsite will be displayed until this date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expression", + "description": "Expression used to associate products to the hotsite.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsiteId", + "description": "Hotsite unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The hotsite\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageSize", + "description": "Set the quantity of products displayed per page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A list of products associated with the hotsite.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sorting", + "description": "Sorting information to be used by default on the hotsite.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "HotsiteSorting", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startDate", + "description": "The hotsite will be displayed from this date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtype", + "description": "The subtype of the hotsite.", + "args": [], + "type": { + "kind": "ENUM", + "name": "HotsiteSubtype", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template", + "description": "The template used for the hotsite.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The hotsite\u0027s URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SingleHotsite", + "description": "A hotsite is a group of products used to organize them or to make them easier to browse.", + "fields": [ + { + "name": "aggregations", + "description": "Aggregations from the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductAggregations", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "banners", + "description": "A list of banners associated with the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "A list of breadcrumbs for the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contents", + "description": "A list of contents associated with the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Content", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endDate", + "description": "The hotsite will be displayed until this date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expression", + "description": "Expression used to associate products to the hotsite.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsiteId", + "description": "Hotsite unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The hotsite\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageSize", + "description": "Set the quantity of products displayed per page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A list of products associated with the hotsite. Cursor pagination.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filters", + "description": "List of filters. Check filters result for available inputs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maximumPrice", + "description": "Maximum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumPrice", + "description": "Minimum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "onlyMainVariant", + "description": "Toggle the return of only main variants.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productsByOffset", + "description": "A list of products associated with the hotsite. Offset pagination.", + "args": [ + { + "name": "filters", + "description": "List of filters. Check filters result for available inputs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "limit", + "description": "The number of products to return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maximumPrice", + "description": "Maximum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumPrice", + "description": "Minimum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "offset", + "description": "The offset used to paginate.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "0" + }, + { + "name": "onlyMainVariant", + "description": "Toggle the return of only main variants.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCollectionSegment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "A list of SEO contents associated with the hotsite.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sorting", + "description": "Sorting information to be used by default on the hotsite.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "HotsiteSorting", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startDate", + "description": "The hotsite will be displayed from this date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtype", + "description": "The subtype of the hotsite.", + "args": [], + "type": { + "kind": "ENUM", + "name": "HotsiteSubtype", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "template", + "description": "The template used for the hotsite.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The hotsite\u0027s URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCollectionSegment", + "description": null, + "fields": [ + { + "name": "items", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageSize", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerOrderCollectionSegment", + "description": null, + "fields": [ + { + "name": "items", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "order", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageSize", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Search", + "description": "Search for relevant products to the searched term.", + "fields": [ + { + "name": "aggregations", + "description": "Aggregations from the products.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductAggregations", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "banners", + "description": "A list of banners displayed in search pages.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "List of search breadcrumbs.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contents", + "description": "A list of contents displayed in search pages.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Content", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "forbiddenTerm", + "description": "Information about forbidden term.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "forbiddenTerm", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageSize", + "description": "The quantity of products displayed per page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A cursor based paginated list of products from the search.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filters", + "description": "List of filters. Check filters result for available inputs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "maximumPrice", + "description": "Maximum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumPrice", + "description": "Minimum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "onlyMainVariant", + "description": "Toggle the return of only main variants.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "ENUM", + "name": "ProductSearchSortKeys", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productsByOffset", + "description": "An offset based paginated list of products from the search.", + "args": [ + { + "name": "filters", + "description": "List of filters. Check filters result for available inputs.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "limit", + "description": "The number of products to return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "10" + }, + { + "name": "maximumPrice", + "description": "Maximum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "minimumPrice", + "description": "Minimum price filter.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "offset", + "description": "The offset used to paginate.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "0" + }, + { + "name": "onlyMainVariant", + "description": "Toggle the return of only main variants.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": "true" + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "ENUM", + "name": "ProductSearchSortKeys", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductCollectionSegment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectUrl", + "description": "Redirection url in case a term in the search triggers a redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "searchTime", + "description": "Time taken to perform the search.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Brand", + "description": "Informations about brands and its products.", + "fields": [ + { + "name": "active", + "description": "If the brand is active at the platform.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alias", + "description": "The alias for the brand\u0027s hotsite.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "brandId", + "description": "Brand unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The date the brand was created in the database.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullUrlLogo", + "description": "The full brand logo URL.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The brand\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A list of products from the brand.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + } + }, + "defaultValue": "NAME" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The last update date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlCarrossel", + "description": "A web address to be redirected.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlLink", + "description": "A web address linked to the brand.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlLogo", + "description": "The url of the brand\u0027s logo.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "description": "Options available for the given product.", + "fields": [ + { + "name": "attributes", + "description": "A list of attributes available for the given product and its variants.", + "args": [ + { + "name": "filter", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizations", + "description": "A list of customizations available for the given products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductFilterInput", + "description": "Custom attribute defined on store\u0027s admin may also be used as a filter.", + "fields": null, + "inputFields": [ + { + "name": "field", + "description": "The attribute name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "values", + "description": "The set of values which the result filter item value must be included in.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Category", + "description": "Categories are used to arrange your products into different sections by similarity.", + "fields": [ + { + "name": "categoryId", + "description": "Category unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "children", + "description": "A list of child categories, if it exists.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Category", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "A description to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayMenu", + "description": "Field to check if the category is displayed in the store\u0027s menu.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsiteAlias", + "description": "The hotsite alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsiteUrl", + "description": "The URL path for the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "The url to access the image linked to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrlLink", + "description": "The web address to access the image linked to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The category\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent", + "description": "The parent category, if it exists.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Category", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentCategoryId", + "description": "The parent category unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The position the category will be displayed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "A list of products associated with the category.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + } + }, + "defaultValue": "NAME" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlLink", + "description": "A web address linked to the category.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Customization", + "description": "Some products can have customizations, such as writing your name on it or other predefined options.", + "fields": [ + { + "name": "cost", + "description": "Cost of customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizationId", + "description": "Customization unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "groupName", + "description": "Customization group\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maxLength", + "description": "Maximum allowed size of the field.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The customization\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Priority order of customization.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Type of customization.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "Value of customization.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SingleProduct", + "description": "A product represents an item for sale in the store.", + "fields": [ + { + "name": "addToCartFromSpot", + "description": "Check if the product can be added to cart directly from spot.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alias", + "description": "The product url alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeSelections", + "description": "Information about the possible selection attributes.", + "args": [ + { + "name": "selected", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AttributeSelection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "List of the product attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": "Field to check if the product is available in stock.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "averageRating", + "description": "The product average rating. From 0 to 5.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "List of product breadcrumbs.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyBox", + "description": "BuyBox informations.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BuyBox", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyTogether", + "description": "Buy together products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SingleProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "condition", + "description": "The product condition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The product creation date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizations", + "description": "A list of customizations available for the given products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deadline", + "description": "The product delivery deadline.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display", + "description": "Check if the product should be displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnlyPartner", + "description": "Check if the product should be displayed only for partners.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displaySearch", + "description": "Check if the product should be displayed on search.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ean", + "description": "The product\u0027s unique EAN.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "freeShipping", + "description": "Check if the product offers free shipping.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "List of the product images.", + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "informations", + "description": "List of the product insformations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Information", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mainVariant", + "description": "Check if its the main variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumOrderQuantity", + "description": "The product minimum quantity for an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newRelease", + "description": "Check if the product is a new release.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfVotes", + "description": "The number of votes that the average rating consists of.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parallelOptions", + "description": "Product parallel options information.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentId", + "description": "Parent product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "The product prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Prices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productBrand", + "description": "Summarized informations about the brand of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductBrand", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCategories", + "description": "Summarized informations about the categories of the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductCategory", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "Product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productName", + "description": "The product name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSubscription", + "description": "Summarized informations about the subscription of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotions", + "description": "List of promotions this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Promotion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "List of customer reviews for this product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Review", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seller", + "description": "The product seller.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Seller", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "Product SEO informations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "similarProducts", + "description": "List of similar products. ", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SimilarProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product\u0027s unique SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotAttributes", + "description": "The values of the spot attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotInformation", + "description": "The product spot information.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotlight", + "description": "Check if the product is on spotlight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock", + "description": "The available stock at the default distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stocks", + "description": "List of the product stocks on different distribution centers.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Stock", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionGroups", + "description": "List of subscription groups this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telesales", + "description": "Check if the product is a telesale.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The product last update date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlVideo", + "description": "The product video url.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantName", + "description": "The variant name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "description": "Product variants that have the attribute.", + "fields": [ + { + "name": "aggregatedStock", + "description": "The available stock at the default distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alias", + "description": "The product alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "List of the selected variant attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": "Field to check if the product is available in stock.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ean", + "description": "The product\u0027s EAN.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "The product\u0027s images.", + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "offers", + "description": "The seller\u0027s product offers.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellerOffer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "The product prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Prices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "Product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantName", + "description": "Product variant name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotions", + "description": "List of promotions this product variant belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Promotion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product\u0027s unique SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock", + "description": "The available stock at the default distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Shop", + "description": "Informations about the store.", + "fields": [ + { + "name": "checkoutUrl", + "description": "Checkout URL", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mainUrl", + "description": "Store main URL", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mobileCheckoutUrl", + "description": "Mobile checkout URL", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mobileUrl", + "description": "Mobile URL", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "modifiedName", + "description": "Store modified name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Store name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "physicalStores", + "description": "Physical stores", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PhysicalStore", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Any", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Upload", + "description": "The \u0060Upload\u0060 scalar type represents a file upload.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "MenuGroup", + "description": "Informations about menu groups.", + "fields": [ + { + "name": "fullImageUrl", + "description": "The full image URL.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "Menu group image url.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menuGroupId", + "description": "Menu group identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menus", + "description": "List of menus associated with the current group", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Menu", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Menu group name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerId", + "description": "Menu group partner id.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "Menu group position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderProductNode", + "description": null, + "fields": [ + { + "name": "adjusts", + "description": "List of adjusts on the product price, if any.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderAdjustNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The product attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderAttributeNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizationPrice", + "description": "The cost of the customizations, if any.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizations", + "description": "List of customizations for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderCustomizationNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Amount of discount in the product price, if any.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift", + "description": "If the product is a gift.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The product image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "listPrice", + "description": "The product list price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "packagingPrice", + "description": "The cost of the packagings, if any.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "packagings", + "description": "List of packagings for the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderPackagingNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The product price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSeller", + "description": "Information about the product seller.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderSellerNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Quantity of the given product in the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "salePrice", + "description": "The product sale price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackings", + "description": "List of trackings for the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTrackingNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "unitaryValue", + "description": "Value of an unit of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProductNode", + "description": null, + "fields": [ + { + "name": "ajustedPrice", + "description": "The product adjusted price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeSelections", + "description": "Information about the possible selection attributes.", + "args": [ + { + "name": "selected", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AttributeSelection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "brand", + "description": "The product brand", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "category", + "description": "The product category", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "gift", + "description": "If the product is a gift", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "googleCategory", + "description": "The product Google category", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "The product URL image", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "informations", + "description": "The product informations", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installmentFee", + "description": "The product installment fee", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installmentValue", + "description": "The product installment value", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "listPrice", + "description": "The product list price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "metadata", + "description": "The metadata related to this checkout.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Metadata", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The product name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfInstallments", + "description": "The product number of installments", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The product price", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productAttributes", + "description": "The product attributes", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutProductAttributeNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "The product unique identifier", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "The product variant unique identifier", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The product quantity", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingDeadline", + "description": "The product shipping deadline", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutShippingDeadlineNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product SKU", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The product URL", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "String", + "description": "The \u0060String\u0060 scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Boolean", + "description": "The \u0060Boolean\u0060 scalar type represents \u0060true\u0060 or \u0060false\u0060.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Int", + "description": "The \u0060Int\u0060 scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ApplyPolicy", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "BEFORE_RESOLVER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AFTER_RESOLVER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "ID", + "description": "The \u0060ID\u0060 scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as \u0060\u00224\u0022\u0060) or integer (such as \u00604\u0060) input value will be accepted as an ID.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Long", + "description": "The \u0060Long\u0060 scalar type represents non-fractional signed whole 64-bit numeric values. Long can represent values between -(2^63) and 2^63 - 1.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CustomerOrderSortKeys", + "description": "Define the order attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The order ID.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DATE", + "description": "The date the order was placed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STATUS", + "description": "The order current status.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AMOUNT", + "description": "The total order value.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderSortDirection", + "description": "Define the sort orientation of the result set.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DESC", + "description": "The results will be sorted in an descending order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ASC", + "description": "The results will be sorted in an ascending order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductsConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductsEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductSortKeys", + "description": "Define the product attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NAME", + "description": "The product name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SALES", + "description": "The sales number on a period of time.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "The product variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT", + "description": "The applied discount to the product variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RANDOM", + "description": "Sort in a random way.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEASE_DATE", + "description": "The date the product was released.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STOCK", + "description": "The quantity in stock of the product variant.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SortDirection", + "description": "Define the sort orientation of the result set.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ASC", + "description": "The results will be sorted in an ascending order.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DESC", + "description": "The results will be sorted in an descending order.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Decimal", + "description": "The built-in \u0060Decimal\u0060 scalar type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductSearchSortKeys", + "description": "Define the product attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "RELEVANCE", + "description": "The relevance that the search engine gave to the possible result item based on own criteria.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "The product name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SALES", + "description": "The sales number on a period of time.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRICE", + "description": "The product variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DISCOUNT", + "description": "The applied discount to the product variant price.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RANDOM", + "description": "Sort in a random way.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RELEASE_DATE", + "description": "The date the product was released.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "STOCK", + "description": "The quantity in stock of the product variant.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeFilterInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "attributeId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PageInfo", + "description": "Information about pagination in a connection.", + "fields": [ + { + "name": "endCursor", + "description": "When paginating forwards, the cursor to continue.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasNextPage", + "description": "Indicates whether more edges exist following the set defined by the clients arguments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hasPreviousPage", + "description": "Indicates whether more edges exist prior the set defined by the clients arguments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startCursor", + "description": "When paginating backwards, the cursor to continue.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Product", + "description": "A product represents an item for sale in the store.", + "fields": [ + { + "name": "addToCartFromSpot", + "description": "Check if the product can be added to cart directly from spot.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alias", + "description": "The product url alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "List of the product attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": "Field to check if the product is available in stock.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "averageRating", + "description": "The product average rating. From 0 to 5.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyBox", + "description": "BuyBox informations.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BuyBox", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "condition", + "description": "The product condition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The product creation date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deadline", + "description": "The product delivery deadline.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display", + "description": "Check if the product should be displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnlyPartner", + "description": "Check if the product should be displayed only for partners.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displaySearch", + "description": "Check if the product should be displayed on search.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ean", + "description": "The product\u0027s unique EAN.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "freeShipping", + "description": "Check if the product offers free shipping.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "List of the product images.", + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "informations", + "description": "List of the product insformations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Information", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mainVariant", + "description": "Check if its the main variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumOrderQuantity", + "description": "The product minimum quantity for an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newRelease", + "description": "Check if the product is a new release.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfVotes", + "description": "The number of votes that the average rating consists of.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentId", + "description": "Parent product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "The product prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Prices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productBrand", + "description": "Summarized informations about the brand of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductBrand", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCategories", + "description": "Summarized informations about the categories of the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductCategory", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "Product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productName", + "description": "The product name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSubscription", + "description": "Summarized informations about the subscription of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotions", + "description": "List of promotions this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Promotion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seller", + "description": "The product seller.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Seller", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "similarProducts", + "description": "List of similar products. ", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SimilarProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product\u0027s unique SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotAttributes", + "description": "The values of the spot attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotInformation", + "description": "The product spot information.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotlight", + "description": "Check if the product is on spotlight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock", + "description": "The available stock at the default distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stocks", + "description": "List of the product stocks on different distribution centers.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Stock", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionGroups", + "description": "List of subscription groups this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telesales", + "description": "Check if the product is a telesale.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The product last update date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlVideo", + "description": "The product video url.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantName", + "description": "The variant name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductsEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "QueryRoot", + "description": null, + "fields": [ + { + "name": "address", + "description": "Get informations about an address.", + "args": [ + { + "name": "cep", + "description": "The address zip code.", + "type": { + "kind": "SCALAR", + "name": "CEP", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "autocomplete", + "description": "Get query completion suggestion.", + "args": [ + { + "name": "limit", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Autocomplete", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "banners", + "description": "List of banners.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "bannerIds", + "description": "Filter the list by specific banner ids.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BannerSortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "BannersConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "brands", + "description": "List of brands", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "brandInput", + "description": "Brand input", + "type": { + "kind": "INPUT_OBJECT", + "name": "BrandFilterInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "BrandSortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "BrandsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyList", + "description": "Retrieve a buylist by the given id.", + "args": [ + { + "name": "id", + "description": "The list ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "BuyList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "calculatePrices", + "description": "Prices informations", + "args": [ + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "products", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CalculatePricesProductsInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Prices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "categories", + "description": "List of categories.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "categoryIds", + "description": "Filter the list by specific category ids.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "CategorySortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "CategoriesConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkout", + "description": "Get info from the checkout cart corresponding to the given ID.", + "args": [ + { + "name": "checkoutId", + "description": "The cart ID used for checkout operations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contents", + "description": "List of contents.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "contentIds", + "description": "Filter the list by specific content ids.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ContentSortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "ContentsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer", + "description": "Get informations about a customer from the store.", + "args": [ + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsite", + "description": "Retrieve a single hotsite. A hotsite consists of products, banners and contents.", + "args": [ + { + "name": "hotsiteId", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SingleHotsite", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hotsites", + "description": "List of the shop\u0027s hotsites. A hotsite consists of products, banners and contents.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "hotsiteIds", + "description": "Filter the list by specific hotsite ids.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "HotsiteSortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "HotsitesConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menuGroups", + "description": "List of menu groups.", + "args": [ + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "position", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "MenuGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newsletterInformationGroupFields", + "description": "Get newsletter information group fields.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InformationGroupFieldNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": null, + "args": [ + { + "name": "id", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": null, + "args": [ + { + "name": "ids", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partner", + "description": "Get single partner.", + "args": [ + { + "name": "partnerAccessToken", + "description": "Filter the partner by access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Partner", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerByRegion", + "description": "Get partner by region.", + "args": [ + { + "name": "input", + "description": "Filter the partner by cep or region ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PartnerByRegionInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Partner", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partners", + "description": "List of partners.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "alias", + "description": "Filter the list by specific alias.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "names", + "description": "Filter the list by specific names.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "priceTableIds", + "description": "Filter the list by specific price table ids.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PartnerSortKeys", + "ofType": null + } + }, + "defaultValue": "ID" + } + ], + "type": { + "kind": "OBJECT", + "name": "PartnersConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentMethods", + "description": "Returns the available payment methods for a given cart ID", + "args": [ + { + "name": "checkoutId", + "description": "The cart ID used for checking available payment methods.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "paymentMethod", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "product", + "description": "Retrieve a product by the given id.", + "args": [ + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The product ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SingleProduct", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productOptions", + "description": "Options available for the given product.", + "args": [ + { + "name": "productId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the product query." + }, + { + "name": "productRecommendations", + "description": "Retrieve a list of recommended products by product id.", + "args": [ + { + "name": "algorithm", + "description": "Algorithm type.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductRecommendationAlgorithm", + "ofType": null + } + }, + "defaultValue": "DEFAULT" + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The product identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "The number of product recommendations.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": "5" + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "Retrieve a list of products by specific filters.", + "args": [ + { + "name": "after", + "description": "Returns the elements in the list that come after the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "before", + "description": "Returns the elements in the list that come before the specified cursor.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "filters", + "description": "The product filters to apply.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ProductExplicitFiltersInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "first", + "description": "Returns the first _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "last", + "description": "Returns the last _n_ elements from the list.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "sortDirection", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + } + }, + "defaultValue": "ASC" + }, + { + "name": "sortKey", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + } + }, + "defaultValue": "NAME" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductsConnection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scripts", + "description": "Retrieve a list of scripts.", + "args": [ + { + "name": "name", + "description": "The script name.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "pageType", + "description": "The script page type list.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ScriptPageType", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "position", + "description": "The script position.", + "type": { + "kind": "ENUM", + "name": "ScriptPosition", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "url", + "description": "Url for available scripts.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Script", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "search", + "description": "Search products with cursor pagination.", + "args": [ + { + "name": "operation", + "description": "The operation to perform between query terms.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "Operation", + "ofType": null + } + }, + "defaultValue": "AND" + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The search query.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Search", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingQuotes", + "description": "Get the shipping quotes by providing CEP and checkout or product identifier.", + "args": [ + { + "name": "cep", + "description": "CEP to get the shipping quotes.", + "type": { + "kind": "SCALAR", + "name": "CEP", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "Checkout identifier to get the shipping quotes.", + "type": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "Product identifier to get the shipping quotes.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": "Quantity of the product to get the shipping quotes.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "useSelectedAddress", + "description": "Use the selected address to get the shipping quotes.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingQuote", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shop", + "description": "Store informations", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Shop", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopSettings", + "description": "Store settings", + "args": [ + { + "name": "settingNames", + "description": "Setting names", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShopSetting", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "uri", + "description": "Get the URI kind.", + "args": [ + { + "name": "url", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Uri", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Mutation", + "description": null, + "fields": [ + { + "name": "checkoutAddCoupon", + "description": "Add coupon to checkout", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "coupon", + "description": "The coupon.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "A customer\u0027s access token", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutAddMetadata", + "description": "Add metadata to checkout", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "A customer\u0027s access token", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metadata", + "description": "The list of metadata to add", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutMetadataInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutAddMetadataForProductVariant", + "description": "Add metadata to a checkout product", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "A customer\u0027s access token", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "metadata", + "description": "The list of metadata to add", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutMetadataInput", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The product to be modifed", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutAddProduct", + "description": "Add products to an existing checkout", + "args": [ + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Params to add products to an existing checkout", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutAddressAssociate", + "description": "Associate the address with a checkout.", + "args": [ + { + "name": "addressId", + "description": "The address ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutClone", + "description": "Clones a cart by the given checkout ID, returns the newly created checkout ID", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "copyUser", + "description": "Flag indicating whether to copy the existing Customer information to the new Checkout. Default is false", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": "false" + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutComplete", + "description": "Completes a checkout", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "comments", + "description": "Order comments.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentData", + "description": "Payment data.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutCustomerAssociate", + "description": "Associate the customer with a checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutGiftVariantSelection", + "description": "Selects the variant of a gift product", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The variant id to select.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutPartnerAssociate", + "description": "Associate the partner with a checkout.", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": "The partner access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutRemoveCoupon", + "description": "Add coupon to checkout", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutRemoveProduct", + "description": "Remove products from an existing checkout", + "args": [ + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "input", + "description": "Params to remove products from an existing checkout", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutSelectInstallment", + "description": "Select installment.", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "installmentNumber", + "description": "The number of installments.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "selectedPaymentMethodId", + "description": "The selected payment method ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutSelectPaymentMethod", + "description": "Select payment method.", + "args": [ + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "paymentMethodId", + "description": "The payment method ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "checkoutSelectShippingQuote", + "description": "Select shipping quote", + "args": [ + { + "name": "additionalInformation", + "description": "The additional information for in-store pickup.", + "type": { + "kind": "INPUT_OBJECT", + "name": "InStorePickupAdditionalInformationInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "checkoutId", + "description": "The checkout ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "deliveryScheduleInput", + "description": "The delivery schedule.", + "type": { + "kind": "INPUT_OBJECT", + "name": "DeliveryScheduleInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "shippingQuoteId", + "description": "The shipping quote unique identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createCheckout", + "description": "Create a new checkout", + "args": [ + { + "name": "products", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductItemInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createNewsletterRegister", + "description": "Register an email in the newsletter.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "NewsletterInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "NewsletterNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createProductReview", + "description": "Adds a review to a product variant.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ReviewCreateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Review", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createSearchTermRecord", + "description": "Record a searched term for admin reports", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SearchRecordInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SearchRecord", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenCreate", + "description": "Creates a new customer access token with an expiration time.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerAccessTokenInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAccessTokenRenew", + "description": "Renews the expiration time of a customer access token. The token must not be expired.", + "args": [ + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddressCreate", + "description": "Create an address.", + "args": [ + { + "name": "address", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CreateCustomerAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerAddressUpdate", + "description": "Change an existing address", + "args": [ + { + "name": "address", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateCustomerAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The customer address unique identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCompletePartialRegistration", + "description": "Allows the user to complete the required information for a partial registration.", + "args": [ + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerSimpleCreateInputGraphInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerCreate", + "description": "Creates a new customer register.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerEmailChange", + "description": "Changes user email.", + "args": [ + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailChangeInput", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OperationResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerImpersonate", + "description": "Impersonates a customer, generating an access token with expiration time.", + "args": [ + { + "name": "customerAccessToken", + "description": "The customer access token.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": "The e-mail input.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPasswordChange", + "description": "Changes user password.", + "args": [ + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CustomerPasswordChangeInputGraphInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OperationResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerPasswordRecovery", + "description": "Sends a password recovery email to the user.", + "args": [ + { + "name": "input", + "description": "The input used to login. Can be either an email or a CPF/CNPJ, if the option is enabled on store settings.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OperationResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSimpleLoginStart", + "description": "Returns the user associated with a simple login (CPF or Email) if exists, else return a New user.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SimpleLogin", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSimpleLoginVerifyAnwser", + "description": "Verify if the answer to a simple login question is correct, returns a new question if the answer is incorrect", + "args": [ + { + "name": "anwserId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "questionId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SimpleLogin", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSocialLoginFacebook", + "description": "Returns the user associated with a Facebook account if exists, else return a New user.", + "args": [ + { + "name": "facebookAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerSocialLoginGoogle", + "description": "Returns the user associated with a Google account if exists, else return a New user.", + "args": [ + { + "name": "clientId", + "description": "The client Id returned from the google credential object.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "userCredential", + "description": "The user credential after authorizing through the google popup window.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerUpdate", + "description": "Updates a customer register.", + "args": [ + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerAccessTokenCreate", + "description": "Creates a new closed scope partner access token with an expiration time.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PartnerAccessTokenInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PartnerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productPriceAlert", + "description": "Add a price alert.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddPriceAlertInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductPriceAlert", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productRestockAlert", + "description": "Creates an alert to notify when the product is back in stock.", + "args": [ + { + "name": "input", + "description": "Params to create an alert for product back in stock.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RestockAlertInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "partnerAccessToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "RestockAlertNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sendGenericForm", + "description": "Send a generic form.", + "args": [ + { + "name": "body", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Any", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "file", + "description": null, + "type": { + "kind": "SCALAR", + "name": "Upload", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OperationResult", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateAddress", + "description": "Change an existing address", + "args": [ + { + "name": "address", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UpdateCustomerAddressInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "customerAccessToken", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "id", + "description": "The customer address unique identifier.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + "isDeprecated": true, + "deprecationReason": "Use the CustomerAddressUpdate mutation." + }, + { + "name": "wishlistAddProduct", + "description": "Adds a product to the customer\u0027s wishlist.", + "args": [ + { + "name": "customerAccessToken", + "description": "A customer\u0027s access token", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "ID of the product to be added to the customer\u0027s wishlist", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wishlistRemoveProduct", + "description": "Removes a product from the customer\u0027s wishlist.", + "args": [ + { + "name": "customerAccessToken", + "description": "A customer\u0027s access token", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "ID of the product to be removed from the customer\u0027s wishlist", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INTERFACE", + "name": "Node", + "description": null, + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "Checkout", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customer", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Hotsite", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SingleHotsite", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Brand", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductOption", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Category", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Customization", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "SingleProduct", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "MenuGroup", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Product", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Content", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Attribute", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Menu", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "Partner", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ShippingQuote", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "paymentMethod", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "InformationGroupFieldNode", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "BuyList", + "ofType": null + } + ] + }, + { + "kind": "OBJECT", + "name": "SelectedPaymentMethod", + "description": "The selected payment method details.", + "fields": [ + { + "name": "id", + "description": "The unique identifier for the selected payment method.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installments", + "description": "The list of installments associated with the selected payment method.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SelectedPaymentMethodInstallment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedInstallment", + "description": "The selected installment.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SelectedPaymentMethodInstallment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutCustomer", + "description": "Represents a customer node in the checkout.", + "fields": [ + { + "name": "cnpj", + "description": "Taxpayer identification number for businesses.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cpf", + "description": "Brazilian individual taxpayer registry identification.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creditLimit", + "description": "The credit limit of the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creditLimitBalance", + "description": "The credit limit balance of the customer.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerId", + "description": "Customer\u0027s unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customerName", + "description": "Customer\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email address of the customer.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "Customer\u0027s phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutAddress", + "description": "Represents an address node in the checkout.", + "fields": [ + { + "name": "addressNumber", + "description": "The street number of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cep", + "description": "The ZIP code of the address.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "complement", + "description": "The additional address information.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighborhood", + "description": "The neighborhood of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referencePoint", + "description": "The reference point for the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "The state of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "The street name of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Metadata", + "description": "Some products can have metadata, like diferent types of custom information. A basic key value pair.", + "fields": [ + { + "name": "key", + "description": "Metadata key.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Metadata value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "DateTime", + "description": "The \u0060DateTime\u0060 scalar represents an ISO-8601 compliant date time type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderDelivery", + "description": "The delivery or store pickup details.", + "fields": [ + { + "name": "address", + "description": "The delivery or store pickup address.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutOrderAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cost", + "description": "The cost of delivery or pickup.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryTime", + "description": "The estimated delivery or pickup time, in days.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the recipient.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderPayment", + "description": "The checkout order payment.", + "fields": [ + { + "name": "invoice", + "description": "The bank invoice payment information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutOrderInvoicePayment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pix", + "description": "The Pix payment information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CheckoutOrderPixPayment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "OrderStatus", + "description": "Represents the status of an order.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PAID", + "description": "Order has been paid.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWAITING_PAYMENT", + "description": "Order is awaiting payment.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED_TEMPORARILY_DENIED_CARD", + "description": "Order has been cancelled - Card Temporarily Denied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED_DENIED_CARD", + "description": "Order has been cancelled - Card Denied.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED_FRAUD", + "description": "Order has been cancelled - Fraud.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED_SUSPECT_FRAUD", + "description": "Order has been cancelled - Suspected Fraud.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED_ORDER_CANCELLED", + "description": "Order has been cancelled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CANCELLED", + "description": "Order has been cancelled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SENT", + "description": "Order has been sent.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHORIZED", + "description": "Order has been authorized.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SENT_INVOICED", + "description": "Order has been sent - Invoiced.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RETURNED", + "description": "Order has been returned.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DOCUMENTS_FOR_PURCHASE", + "description": "Documents needed for purchase.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "APPROVED_ANALYSIS", + "description": "Order has been approved in analysis.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RECEIVED_GIFT_CARD", + "description": "Order has been received - Gift Card.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEPARATED", + "description": "Order has been separated.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ORDERED", + "description": "Order has been placed.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DELIVERED", + "description": "Order has been delivered.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AWAITING_PAYMENT_CHANGE", + "description": "Order is awaiting change of payment method.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CHECKED_ORDER", + "description": "Order has been checked.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PICK_UP_IN_STORE", + "description": "Available for pick-up in store.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "DENIED_PAYMENT", + "description": "Payment denied, but the order has not been cancelled.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREDITED", + "description": "Order has been credited.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderProduct", + "description": "Represents a node in the checkout order products.", + "fields": [ + { + "name": "adjustments", + "description": "The list of adjustments applied to the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutOrderProductAdjustment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "The list of attributes of the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CheckoutOrderProductAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "The image URL of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "The ID of the product variant.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderAdjustment", + "description": "Represents an adjustment applied to checkout.", + "fields": [ + { + "name": "name", + "description": "The name of the adjustment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the adjustment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "DeliveryScheduleDetail", + "description": "The delivery schedule detail.", + "fields": [ + { + "name": "date", + "description": "The date of the delivery schedule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endDateTime", + "description": "The end date and time of the delivery schedule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endTime", + "description": "The end time of the delivery schedule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startDateTime", + "description": "The start date and time of the delivery schedule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startTime", + "description": "The start time of the delivery schedule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "Float", + "description": "The \u0060Float\u0060 scalar type represents signed double-precision fractional values as specified by [IEEE 754](http://en.wikipedia.org/wiki/IEEE_floating_point).", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAddressNode", + "description": null, + "fields": [ + { + "name": "addressDetails", + "description": "Address details.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addressNumber", + "description": "Address number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cep", + "description": "zip code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "address city.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "Country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The email of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighborhood", + "description": "Address neighborhood.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phone", + "description": "The phone of the customer address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referencePoint", + "description": "Address reference point.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "State.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "Address street.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerPartnerNode", + "description": null, + "fields": [ + { + "name": "alias", + "description": "The partner alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The partner\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerAccessToken", + "description": "The partner\u0027s access token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "wishlist", + "description": null, + "fields": [ + { + "name": "products", + "description": "Wishlist products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerInformationGroupNode", + "description": null, + "fields": [ + { + "name": "exibitionName", + "description": "The group exibition name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fields", + "description": "The group fields.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CustomerInformationGroupFieldNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The group name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerOrdersStatistics", + "description": null, + "fields": [ + { + "name": "productsQuantity", + "description": "The number of products the customer made from the number of orders.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The number of orders the customer made.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HotsiteSorting", + "description": null, + "fields": [ + { + "name": "direction", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "SortDirection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "field", + "description": null, + "args": [], + "type": { + "kind": "ENUM", + "name": "ProductSortKeys", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "HotsiteSubtype", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "CATEGORY", + "description": "Hotsite created from a category.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAND", + "description": "Hotsite created from a brand.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PORTFOLIO", + "description": "Hotsite created from a portfolio.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUY_LIST", + "description": "Hotsite created from a buy list (lista de compra).", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Banner", + "description": "A banner is usually an image used to show sales, highlight products, announcements or to redirect to another page or hotsite on click.", + "fields": [ + { + "name": "altText", + "description": "Banner\u0027s alternative text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bannerId", + "description": "Banner unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bannerName", + "description": "Banner\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "bannerUrl", + "description": "URL where the banner is stored.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creationDate", + "description": "The date the banner was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnAllPages", + "description": "Field to check if the banner should be displayed on all pages.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnCategories", + "description": "Field to check if the banner should be displayed on category pages.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnSearches", + "description": "Field to check if the banner should be displayed on search pages.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnWebsite", + "description": "Field to check if the banner should be displayed on the website.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayToPartners", + "description": "Field to check if the banner should be displayed to partners.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The banner\u0027s height in px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openNewTab", + "description": "Field to check if the banner URL should open in another tab on click.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The displaying order of the banner.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The displaying position of the banner.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "searchTerms", + "description": "A list of terms to display the banner on search.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The banner\u0027s title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlOnClick", + "description": "URL to be redirected on click.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The banner\u0027s width in px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Content", + "description": "Contents are used to show things to the user.", + "fields": [ + { + "name": "content", + "description": "The content in html to be displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "contentId", + "description": "Content unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "creationDate", + "description": "The date the content was created.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "height", + "description": "The content\u0027s height in px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The content\u0027s position.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "searchTerms", + "description": "A list of terms to display the content on search.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The content\u0027s title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "width", + "description": "The content\u0027s width in px.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SEO", + "description": "Entity SEO information.", + "fields": [ + { + "name": "content", + "description": "Content of SEO.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "httpEquiv", + "description": "Equivalent SEO type for HTTP.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of SEO.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scheme", + "description": "Scheme for SEO.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Type of SEO.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Breadcrumb", + "description": "Informations about breadcrumb.", + "fields": [ + { + "name": "link", + "description": "Breadcrumb link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "Breadcrumb text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductAggregations", + "description": null, + "fields": [ + { + "name": "filters", + "description": "List of product filters which can be used to filter subsequent queries.", + "args": [ + { + "name": "position", + "description": "The filter position.", + "type": { + "kind": "ENUM", + "name": "FilterPosition", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchFilter", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumPrice", + "description": "Minimum price of the products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumPrice", + "description": "Maximum price of the products.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceRanges", + "description": "List of price ranges for the selected products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceRange", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "order", + "description": null, + "fields": [ + { + "name": "coupon", + "description": "The coupon for discounts.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "currentAccount", + "description": "Current account value used for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date", + "description": "The date when te order was placed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryAddress", + "description": "The address where the order will be delivered.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderDeliveryAddressNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Order discount amount, if any.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "interestFee", + "description": "Order interest fee, if any.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "invoices", + "description": "Information about order invoices.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderInvoiceNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "notes", + "description": "Information about order notes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderNoteNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "orderId", + "description": "Order unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentDate", + "description": "The date when the order was payed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "payments", + "description": "Information about payments.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderPaymentNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "Products belonging to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderProductNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotions", + "description": "List of promotions applied to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingFee", + "description": "The shipping fee.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippings", + "description": "Information about order shippings.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderShippingNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The order current status.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderStatusNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusHistory", + "description": "List of the order status history.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderStatusNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "Order subtotal value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "Order total value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "trackings", + "description": "Information about order trackings.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderTrackingNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "forbiddenTerm", + "description": "Informations about a forbidden search term.", + "fields": [ + { + "name": "suggested", + "description": "The suggested search term instead.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "The text to display about the term.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Attribute", + "description": "Attributes available for the variant products from the given productId.", + "fields": [ + { + "name": "attributeId", + "description": "The id of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayType", + "description": "The display type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The values of the attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Review", + "description": "A product review written by a customer.", + "fields": [ + { + "name": "customer", + "description": "The reviewer name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The reviewer e-mail.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "rating", + "description": "The review rating.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "review", + "description": "The review content.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviewDate", + "description": "The review date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeSelection", + "description": "Attributes available for the variant products from the given productId.", + "fields": [ + { + "name": "canBeMatrix", + "description": "Check if the current product attributes can be rendered as a matrix.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "candidateVariant", + "description": "The candidate variant given the current input filters. Variant may be from brother product Id.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "matrix", + "description": "Informations about the attribute matrix.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AttributeMatrix", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selectedVariant", + "description": "The selected variant given the current input filters. Variant may be from brother product Id.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selections", + "description": "Attributes available for the variant products from the given productId.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeSelectionOption", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Image", + "description": "Informations about an image of a product.", + "fields": [ + { + "name": "fileName", + "description": "The name of the image file.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mini", + "description": "Check if the image is used for the product main image.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Numeric order the image should be displayed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "print", + "description": "Check if the image is used for the product prints only.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The url to retrieve the image", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Promotion", + "description": "Information about promotions of a product.", + "fields": [ + { + "name": "content", + "description": "The promotion html content.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "disclosureType", + "description": "Where the promotion is shown (spot, product page, etc..).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullStampUrl", + "description": "The stamp URL of the promotion.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The promotion id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stamp", + "description": "The stamp of the promotion.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The promotion title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductBrand", + "description": null, + "fields": [ + { + "name": "alias", + "description": "The hotsite url alias fot this brand.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullUrlLogo", + "description": "The full brand logo URL.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The brand id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logoUrl", + "description": "The url that contains the brand logo image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the brand.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Prices", + "description": "The prices of the product.", + "fields": [ + { + "name": "bestInstallment", + "description": "The best installment option available.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BestInstallment", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discountPercentage", + "description": "The amount of discount in percentage.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discounted", + "description": "Wether the current price is discounted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installmentPlans", + "description": "List of the possibles installment plans.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InstallmentPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "listPrice", + "description": "The listed regular price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "multiplicationFactor", + "description": "The multiplication factor used for items that are sold by quantity.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The current working price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceTables", + "description": "List of the product different price tables. \n\n Only returned when using the partnerAccessToken or public price tables.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PriceTable", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "wholesalePrices", + "description": "Lists the different price options when buying the item over the given quantity.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "WholesalePrices", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductSubscription", + "description": null, + "fields": [ + { + "name": "discount", + "description": "The amount of discount if this product is sold as a subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The price of the product when sold as a subscription.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionOnly", + "description": "Wether this product is sold only as a subscrition.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductAttribute", + "description": "The attributes of the product.", + "fields": [ + { + "name": "attributeId", + "description": "The id of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayType", + "description": "The display type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Stock", + "description": "Information about a product stock in a particular distribution center.", + "fields": [ + { + "name": "id", + "description": "The id of the distribution center.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "The number of physical items in stock at this DC.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductCategory", + "description": "Information about the category of a product.", + "fields": [ + { + "name": "active", + "description": "Wether the category is currently active.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "googleCategories", + "description": "The categories in google format.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "hierarchy", + "description": "The category hierarchy.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The id of the category.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "main", + "description": "Wether this category is the main category for this product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The category name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The category hotsite url alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Information", + "description": "Information registred to the product.", + "fields": [ + { + "name": "id", + "description": "The information id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The information title.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The information type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The information value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionGroup", + "description": null, + "fields": [ + { + "name": "recurringTypes", + "description": "The recurring types for this subscription group.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionRecurringType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "The status name of the group.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusId", + "description": "The status id of the group.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionGroupId", + "description": "The subscription group id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionOnly", + "description": "Wether the product is only avaible for subscription.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimilarProduct", + "description": "Information about a similar product.", + "fields": [ + { + "name": "alias", + "description": "The url alias of this similar product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "image", + "description": "The file name of the similar product image.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "The URL of the similar product image.", + "args": [ + { + "name": "h", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "w", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the similar product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BuyBox", + "description": "BuyBox informations.", + "fields": [ + { + "name": "installmentPlans", + "description": "List of the possibles installment plans.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InstallmentPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maximumPrice", + "description": "Maximum price among sellers.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumPrice", + "description": "Minimum price among sellers.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantityOffers", + "description": "Quantity of offers.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sellers", + "description": "List of sellers.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Seller", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Seller", + "description": "Seller informations.", + "fields": [ + { + "name": "name", + "description": "Seller name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellerOffer", + "description": "The seller\u0027s product offer", + "fields": [ + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "The product prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "SellerPrices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PhysicalStore", + "description": "Informations about the physical store.", + "fields": [ + { + "name": "additionalText", + "description": "Additional text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "address", + "description": "Physical store address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addressDetails", + "description": "Physical store address details.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "addressNumber", + "description": "Physical store address number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "Physical store address city.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "Physical store country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ddd", + "description": "Physical store DDD.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliveryDeadline", + "description": "Delivery deadline.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "Physical store email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "latitude", + "description": "Physical store latitude.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "longitude", + "description": "Physical store longitude.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Physical store name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighborhood", + "description": "Physical store address neighborhood.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "phoneNumber", + "description": "Physical store phone number.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "physicalStoreId", + "description": "Physical store ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickup", + "description": "If the physical store allows pickup.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickupDeadline", + "description": "Pickup deadline.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "Physical store state.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "zipCode", + "description": "Physical store zip code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Menu", + "description": "Informations about menu items.", + "fields": [ + { + "name": "cssClass", + "description": "Menu css class to apply.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullImageUrl", + "description": "The full image URL.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "Menu image url address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "level", + "description": "Menu hierarchy level.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "link", + "description": "Menu link address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menuGroupId", + "description": "Menu group identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "menuId", + "description": "Menu identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Menu name.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openNewTab", + "description": "Menu hierarchy level.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "Menu position order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentMenuId", + "description": "Parent menu identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "text", + "description": "Menu extra text.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderAdjustNode", + "description": null, + "fields": [ + { + "name": "name", + "description": "The adjust name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "Note about the adjust.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "Type of adjust.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Amount to be adjusted.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderAttributeNode", + "description": null, + "fields": [ + { + "name": "name", + "description": "The attribute name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPackagingNode", + "description": null, + "fields": [ + { + "name": "cost", + "description": "The packaging cost.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The packaging description.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "The message added to the packaging.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The packaging name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderCustomizationNode", + "description": null, + "fields": [ + { + "name": "cost", + "description": "The customization cost.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The customization name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The customization value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderTrackingNode", + "description": null, + "fields": [ + { + "name": "code", + "description": "The tracking code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The URL for tracking.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderSellerNode", + "description": null, + "fields": [ + { + "name": "name", + "description": "The seller\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutShippingDeadlineNode", + "description": null, + "fields": [ + { + "name": "deadline", + "description": "The shipping deadline", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "description", + "description": "The shipping description", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secondDescription", + "description": "The shipping second description", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "secondTitle", + "description": "The shipping second title", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "title", + "description": "The shipping title", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutProductAttributeNode", + "description": null, + "fields": [ + { + "name": "name", + "description": "The attribute name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The attribute type", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The attribute value", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "CEP", + "description": "Represents a CEP", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BannersConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BannersEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BrandsConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BrandsEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Brand", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totalCount", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoriesConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CategoriesEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Category", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ContentsConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ContentsEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Content", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HotsitesConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "HotsitesEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Hotsite", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PartnersConnection", + "description": "A connection to a list of items.", + "fields": [ + { + "name": "edges", + "description": "A list of edges.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PartnersEdge", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "nodes", + "description": "A flattened list of the nodes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Partner", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageInfo", + "description": "Information to aid in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BannersEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Banner", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BrandsEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Brand", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CategoriesEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Category", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ContentsEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Content", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "HotsitesEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Hotsite", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Partner", + "description": "Partners are used to assign specific products or price tables depending on its scope.", + "fields": [ + { + "name": "alias", + "description": "The partner alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "endDate", + "description": "The partner is valid until this date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fullUrlLogo", + "description": "The full partner logo URL.", + "args": [ + { + "name": "height", + "description": "The height of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "logoUrl", + "description": "The partner logo\u0027s URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The partner\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "origin", + "description": "The partner\u0027s origin.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerAccessToken", + "description": "The partner\u0027s access token.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerId", + "description": "Partner unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "portfolioId", + "description": "Portfolio identifier assigned to this partner.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceTableId", + "description": "Price table identifier assigned to this partner.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "startDate", + "description": "The partner is valid from this date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of scoped the partner is used.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PartnersEdge", + "description": "An edge in a connection.", + "fields": [ + { + "name": "cursor", + "description": "A cursor for use in pagination.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "node", + "description": "The item at the end of the edge.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Partner", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "FilterPosition", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "VERTICAL", + "description": "Vertical filter position.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HORIZONTAL", + "description": "Horizontal filter position.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BOTH", + "description": "Both filter position.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchFilter", + "description": "Aggregated filters of a list of products.", + "fields": [ + { + "name": "field", + "description": "The name of the field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "origin", + "description": "The origin of the field.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "List of the values of the field.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchFilterItem", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerInformationGroupFieldNode", + "description": null, + "fields": [ + { + "name": "name", + "description": "The field name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The field order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "If the field is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The field value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderProductAdjustment", + "description": "Represents an adjustment applied to a product in the checkout order.", + "fields": [ + { + "name": "additionalInformation", + "description": "Additional information about the adjustment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the adjustment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The type of the adjustment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the adjustment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderProductAttribute", + "description": "Represents an attribute of a product.", + "fields": [ + { + "name": "name", + "description": "The name of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderPixPayment", + "description": "This represents a Pix payment node in the checkout order.", + "fields": [ + { + "name": "qrCode", + "description": "The QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qrCodeExpirationDate", + "description": "The expiration date of the QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qrCodeUrl", + "description": "The image URL of the QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderInvoicePayment", + "description": "The invoice payment information.", + "fields": [ + { + "name": "digitableLine", + "description": "The digitable line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentLink", + "description": "The payment link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CheckoutOrderAddress", + "description": "The delivery or store Pickup Address.", + "fields": [ + { + "name": "address", + "description": "The street address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cep", + "description": "The ZIP code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "complement", + "description": "Additional information or details about the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isPickupStore", + "description": "Indicates whether the order is for store pickup.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighborhood", + "description": "The neighborhood.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickupStoreText", + "description": ".", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SelectedPaymentMethodInstallment", + "description": "Details of an installment of the selected payment method.", + "fields": [ + { + "name": "adjustment", + "description": "The adjustment value applied to the installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The installment number.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total value of the installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The individual value of each installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "SearchRecordInput", + "description": "The information to be saved for reports.", + "fields": null, + "inputFields": [ + { + "name": "operation", + "description": "The search operation (And, Or)", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "page", + "description": "The current page", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "How many products show in page", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pageUrl", + "description": "The client search page url", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "query", + "description": "The user search query", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "totalResults", + "description": "How many products the search returned", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchRecord", + "description": "The response data", + "fields": [ + { + "name": "date", + "description": "The date time of the processed request", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "isSuccess", + "description": "If the record was successful", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "query", + "description": "The searched query", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "RestockAlertInput", + "description": "Back in stock registration input parameters.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "Email to be notified.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "Name of the person to be notified.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The product variant id of the product to be notified.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "RestockAlertNode", + "description": null, + "fields": [ + { + "name": "email", + "description": "Email to be notified.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "Name of the person to be notified.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "The product variant id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestDate", + "description": "Date the alert was requested.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AddPriceAlertInput", + "description": "Price alert input parameters.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The alerted\u0027s email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The alerted\u0027s name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The product variant id to create the price alert.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "targetPrice", + "description": "The target price to alert.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ProductPriceAlert", + "description": "A product price alert.", + "fields": [ + { + "name": "email", + "description": "The alerted\u0027s email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The alerted\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priceAlertId", + "description": "The price alert ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "The product variant ID.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requestDate", + "description": "The request date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "targetPrice", + "description": "The target price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ReviewCreateInput", + "description": "Review input parameters.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": "The reviewer\u0027s email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The reviewer\u0027s name.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The product variant id to add the review to.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "rating", + "description": "The review rating.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": "The google recaptcha token.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "review", + "description": "The review content.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "NewsletterInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "email", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "informationGroupValues", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "InformationGroupValueInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "recaptchaToken", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "NewsletterNode", + "description": null, + "fields": [ + { + "name": "createDate", + "description": "Newsletter creation date.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "email", + "description": "The newsletter receiver email.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The newsletter receiver name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updateDate", + "description": "Newsletter update date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerSimpleCreateInputGraphInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "birthDate", + "description": "The date of birth of the customer.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cnpj", + "description": "The Brazilian tax identification number for corporations.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "corporateName", + "description": "The legal name of the corporate customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cpf", + "description": "The Brazilian tax identification number for individuals.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerType", + "description": "Indicates if it is a natural person or company profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "EntityType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fullName", + "description": "The full name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "isStateRegistrationExempt", + "description": "Indicates if the customer is state registration exempt.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneAreaCode", + "description": "The area code for the customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneNumber", + "description": "The customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stateRegistration", + "description": "The state registration number for businesses.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SimpleLogin", + "description": null, + "fields": [ + { + "name": "customerAccessToken", + "description": "The customer access token", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "question", + "description": "The simple login question to answer", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Question", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The simple login type", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "SimpleLoginType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerEmailChangeInput", + "description": "The input to change the user email.", + "fields": null, + "inputFields": [ + { + "name": "newEmail", + "description": "The new email.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerPasswordChangeInputGraphInput", + "description": "The input to change the user password.", + "fields": null, + "inputFields": [ + { + "name": "currentPassword", + "description": "The current password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "newPassword", + "description": "The new password.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerUpdateInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "birthDate", + "description": "The date of birth of the customer.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cnpj", + "description": "The Brazilian tax identification number for corporations.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "corporateName", + "description": "The legal name of the corporate customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cpf", + "description": "The Brazilian tax identification number for individuals.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerType", + "description": "Indicates if it is a natural person or company profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "EntityType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "fullName", + "description": "The full name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The gender of the customer.", + "type": { + "kind": "ENUM", + "name": "Gender", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneAreaCode", + "description": "The area code for the customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneNumber", + "description": "The customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "rg", + "description": "The Brazilian register identification number for individuals.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "secondaryPhoneAreaCode", + "description": "The area code for the customer\u0027s secondary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "secondaryPhoneNumber", + "description": "The customer\u0027s secondary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stateRegistration", + "description": "The state registration number for businesses.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerCreateInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "address", + "description": "The street address for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "address2", + "description": "The street address for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "addressComplement", + "description": "Any additional information related to the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "addressNumber", + "description": "The building number for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "birthDate", + "description": "The date of birth of the customer.", + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cep", + "description": "The CEP for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": "The city for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cnpj", + "description": "The Brazilian tax identification number for corporations.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "corporateName", + "description": "The legal name of the corporate customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country", + "description": "The country for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cpf", + "description": "The Brazilian tax identification number for individuals.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "customerType", + "description": "Indicates if it is a natural person or company profile.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "EntityType", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": "The email of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "fullName", + "description": "The full name of the customer.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "gender", + "description": "The gender of the customer.", + "type": { + "kind": "ENUM", + "name": "Gender", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "isStateRegistrationExempt", + "description": "Indicates if the customer is state registration exempt.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "neighborhood", + "description": "The neighborhood for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "newsletter", + "description": "Indicates if the customer has subscribed to the newsletter.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "password", + "description": "The password for the customer\u0027s account.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "passwordConfirmation", + "description": "The password confirmation for the customer\u0027s account.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneAreaCode", + "description": "The area code for the customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "primaryPhoneNumber", + "description": "The customer\u0027s primary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "receiverName", + "description": "The name of the receiver for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reference", + "description": "A reference point or description to help locate the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "reseller", + "description": "Indicates if the customer is a reseller.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "secondaryPhoneAreaCode", + "description": "The area code for the customer\u0027s secondary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "secondaryPhoneNumber", + "description": "The customer\u0027s secondary phone number.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "state", + "description": "The state for the registered address.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stateRegistration", + "description": "The state registration number for businesses.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PartnerAccessTokenInput", + "description": "The input to authenticate closed scope partners.", + "fields": null, + "inputFields": [ + { + "name": "password", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "username", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PartnerAccessToken", + "description": null, + "fields": [ + { + "name": "token", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validUntil", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerAccessTokenInput", + "description": "The input to authenticate a user.", + "fields": null, + "inputFields": [ + { + "name": "email", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "password", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "CustomerAccessToken", + "description": null, + "fields": [ + { + "name": "isMaster", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "token", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The user login type", + "args": [], + "type": { + "kind": "ENUM", + "name": "LoginType", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "validUntil", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OperationResult", + "description": "Result of the operation.", + "fields": [ + { + "name": "isSuccess", + "description": "If the operation is a success.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CreateCustomerAddressInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "addressDetails", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "addressNumber", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "cep", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "CEP", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "city", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "country", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "CountryCode", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "email", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "EmailAddress", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "neighborhood", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "phone", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "referencePoint", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "state", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "street", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "UpdateCustomerAddressInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "addressDetails", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "addressNumber", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "cep", + "description": null, + "type": { + "kind": "SCALAR", + "name": "CEP", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "city", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "country", + "description": null, + "type": { + "kind": "SCALAR", + "name": "CountryCode", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "email", + "description": null, + "type": { + "kind": "SCALAR", + "name": "EmailAddress", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "neighborhood", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "phone", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "referencePoint", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "state", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "street", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutMetadataInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "key", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceRange", + "description": "Range of prices for this product.", + "fields": [ + { + "name": "quantity", + "description": "The quantity of products in this range.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "range", + "description": "The price range.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InStorePickupAdditionalInformationInput", + "description": "The additional information about in-store pickup", + "fields": null, + "inputFields": [ + { + "name": "document", + "description": "The document", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The name", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "DeliveryScheduleInput", + "description": "Input for delivery scheduling.", + "fields": null, + "inputFields": [ + { + "name": "date", + "description": "The date.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "periodId", + "description": "The period ID.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "id", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "products", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductItemInput", + "ofType": null + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutProductItemInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "customization", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutCustomizationInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "metadata", + "description": null, + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CheckoutMetadataInput", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "subscription", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "CheckoutSubscriptionInput", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Uri", + "description": "Node of URI Kind.", + "fields": [ + { + "name": "hotsiteSubtype", + "description": "The origin of the hotsite.", + "args": [], + "type": { + "kind": "ENUM", + "name": "HotsiteSubtype", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "kind", + "description": "Path kind.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "UriKind", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "partnerSubtype", + "description": "The partner subtype.", + "args": [], + "type": { + "kind": "ENUM", + "name": "PartnerSubtype", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productAlias", + "description": "Product alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCategoriesIds", + "description": "Product categories IDs.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectCode", + "description": "Redirect status code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "redirectUrl", + "description": "Url to redirect.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShopSetting", + "description": "Store setting.", + "fields": [ + { + "name": "name", + "description": "Setting name", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Setting value", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingQuote", + "description": "A shipping quote.", + "fields": [ + { + "name": "deadline", + "description": "The shipping deadline.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deliverySchedules", + "description": "The available time slots for scheduling the delivery of the shipping quote.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "deliverySchedule", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The shipping name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The products related to the shipping.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShippingProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingQuoteId", + "description": "The shipping quote unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Uuid", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "type", + "description": "The shipping type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The shipping value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "Operation", + "description": "Types of operations to perform between query terms.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "AND", + "description": "Performs AND operation between query terms.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OR", + "description": "Performs OR operation between query terms.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ScriptPageType", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ALL", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HOME", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SEARCH", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CATEGORY", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BRAND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ScriptPosition", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "HEADER_START", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HEADER_END", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BODY_START", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BODY_END", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOOTER_START", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FOOTER_END", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Script", + "description": "Returns the scripts registered in the script manager.", + "fields": [ + { + "name": "content", + "description": "The script content.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The script name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pageType", + "description": "The script page type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ScriptPageType", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "position", + "description": "The script position.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ScriptPosition", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "priority", + "description": "The script priority.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CalculatePricesProductsInput", + "description": "The products to calculate prices.", + "fields": null, + "inputFields": [ + { + "name": "productVariantId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "quantity", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ProductRecommendationAlgorithm", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "DEFAULT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "ProductExplicitFiltersInput", + "description": "Filter product results based on giving attributes.", + "fields": null, + "inputFields": [ + { + "name": "attributes", + "description": "The set of attributes do filter.", + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "available", + "description": "Choose if you want to retrieve only the available products in stock.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "brandId", + "description": "The set of brand IDs which the result item brand ID must be included in.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "categoryId", + "description": "The set of category IDs which the result item category ID must be included in.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "ean", + "description": "The set of EANs which the result item EAN must be included.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "hasImages", + "description": "Retrieve the product variant only if it contains images.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "mainVariant", + "description": "Retrieve the product variant only if it is the main product variant.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "prices", + "description": "The set of prices to filter.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PricesInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "productId", + "description": "The product unique identifier (you may provide a list of IDs if needed).", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "productVariantId", + "description": "The product variant unique identifier (you may provide a list of IDs if needed).", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sameParentAs", + "description": "A product ID or a list of IDs to search for other products with the same parent ID.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "sku", + "description": "The set of SKUs which the result item SKU must be included.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "stock_gte", + "description": "Show products with a quantity of available products in stock greater than or equal to the given number.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stock_lte", + "description": "Show products with a quantity of available products in stock less than or equal to the given number.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stocks", + "description": "The set of stocks to filter.", + "type": { + "kind": "INPUT_OBJECT", + "name": "StocksInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "updatedAt_gte", + "description": "Retrieve products which the last update date is greater than or equal to the given date.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "updatedAt_lte", + "description": "Retrieve products which the last update date is less than or equal to the given date.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "paymentMethod", + "description": null, + "fields": [ + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "imageUrl", + "description": "The url link that displays for the payment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the payment method.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PartnerByRegionInput", + "description": "Input for partners.", + "fields": null, + "inputFields": [ + { + "name": "cep", + "description": "CEP to get the regional partners.", + "type": { + "kind": "SCALAR", + "name": "CEP", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "regionId", + "description": "Region ID to get the regional partners.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PartnerSortKeys", + "description": "Define the partner attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The partner unique identifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "The partner name.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InformationGroupFieldNode", + "description": null, + "fields": [ + { + "name": "displayType", + "description": "The information group field display type.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fieldName", + "description": "The information group field name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order", + "description": "The information group field order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "required", + "description": "If the information group field is required.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The information group field preset values.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "InformationGroupFieldValueNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "HotsiteSortKeys", + "description": "Define the hotsite attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The hotsite id.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "The hotsite name.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "URL", + "description": "The hotsite url.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "ContentSortKeys", + "description": "Define the content attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The content\u0027s unique identifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CreationDate", + "description": "The content\u0027s creation date.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "CategorySortKeys", + "description": "Define the category attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The category unique identifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "The category name.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BuyList", + "description": "A buy list represents a list of items for sale in the store.", + "fields": [ + { + "name": "addToCartFromSpot", + "description": "Check if the product can be added to cart directly from spot.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "alias", + "description": "The product url alias.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributeSelections", + "description": "Information about the possible selection attributes.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AttributeSelection", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "attributes", + "description": "List of the product attributes.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductAttribute", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": "Field to check if the product is available in stock.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "averageRating", + "description": "The product average rating. From 0 to 5.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "breadcrumbs", + "description": "List of product breadcrumbs.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Breadcrumb", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyBox", + "description": "BuyBox informations.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "BuyBox", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyListId", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyListProducts", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "BuyListProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "buyTogether", + "description": "Buy together products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SingleProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "condition", + "description": "The product condition.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "createdAt", + "description": "The product creation date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customizations", + "description": "A list of customizations available for the given products.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Customization", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deadline", + "description": "The product delivery deadline.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "display", + "description": "Check if the product should be displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayOnlyPartner", + "description": "Check if the product should be displayed only for partners.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displaySearch", + "description": "Check if the product should be displayed on search.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "ean", + "description": "The product\u0027s unique EAN.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "freeShipping", + "description": "Check if the product offers free shipping.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The node unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "images", + "description": "List of the product images.", + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Image", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "informations", + "description": "List of the product insformations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Information", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mainVariant", + "description": "Check if its the main variant.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "minimumOrderQuantity", + "description": "The product minimum quantity for an order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "newRelease", + "description": "Check if the product is a new release.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "numberOfVotes", + "description": "The number of votes that the average rating consists of.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parallelOptions", + "description": "Product parallel options information.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parentId", + "description": "Parent product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "prices", + "description": "The product prices.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Prices", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productBrand", + "description": "Summarized informations about the brand of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductBrand", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productCategories", + "description": "Summarized informations about the categories of the product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductCategory", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productId", + "description": "Product unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productName", + "description": "The product name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productSubscription", + "description": "Summarized informations about the subscription of the product.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "ProductSubscription", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotions", + "description": "List of promotions this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Promotion", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "reviews", + "description": "List of customer reviews for this product.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Review", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seller", + "description": "The product seller.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "Seller", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "seo", + "description": "Product SEO informations.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SEO", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "similarProducts", + "description": "List of similar products. ", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SimilarProduct", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product\u0027s unique SKU.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotAttributes", + "description": "The values of the spot attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotInformation", + "description": "The product spot information.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "spotlight", + "description": "Check if the product is on spotlight.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock", + "description": "The available stock at the default distribution center.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stocks", + "description": "List of the product stocks on different distribution centers.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Stock", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subscriptionGroups", + "description": "List of subscription groups this product belongs to.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SubscriptionGroup", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telesales", + "description": "Check if the product is a telesale.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "updatedAt", + "description": "The product last update date.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "urlVideo", + "description": "The product video url.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "variantName", + "description": "The variant name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + { + "kind": "INTERFACE", + "name": "Node", + "ofType": null + } + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BrandSortKeys", + "description": "Define the brand attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The brand unique identifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NAME", + "description": "The brand name.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "BrandFilterInput", + "description": "Filter brand results based on giving attributes.", + "fields": null, + "inputFields": [ + { + "name": "brandIds", + "description": "Its unique identifier (you may provide a list of IDs if needed).", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "groupIds", + "description": "Its brand group unique identifier (you may provide a list of IDs if needed).", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "groupNames", + "description": "The set of group brand names which the result item name must be included in.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "names", + "description": "The set of brand names which the result item name must be included in.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "BannerSortKeys", + "description": "Define the banner attribute which the result set will be sorted on.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "ID", + "description": "The banner\u0027s unique identifier.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CREATION_DATE", + "description": "The banner\u0027s creation date.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Autocomplete", + "description": "Get query completion suggestion.", + "fields": [ + { + "name": "products", + "description": "Suggested products based on the current query.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Product", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "suggestions", + "description": "List of possible query completions.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AddressNode", + "description": null, + "fields": [ + { + "name": "cep", + "description": "Zip code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "Address city.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "Address country.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighborhood", + "description": "Address neighborhood.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "Address state.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "Address street.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderNoteNode", + "description": null, + "fields": [ + { + "name": "date", + "description": "Date the note was added to the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "note", + "description": "The note added to the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user", + "description": "The user who added the note to the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderDeliveryAddressNode", + "description": null, + "fields": [ + { + "name": "addressNumber", + "description": "The street number of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "cep", + "description": "The ZIP code of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "city", + "description": "The city of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "complement", + "description": "The additional address information.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country", + "description": "The country of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "neighboorhood", + "description": "The neighborhood of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "receiverName", + "description": "The receiver\u0027s name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "referencePoint", + "description": "The reference point for the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "state", + "description": "The state of the address, abbreviated.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": "The street name of the address.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderShippingNode", + "description": null, + "fields": [ + { + "name": "deadline", + "description": "Limit date of delivery, in days.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "deadlineText", + "description": "Deadline text message.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "distributionCenterId", + "description": "Distribution center unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pickUpId", + "description": "The order pick up unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "products", + "description": "The products belonging to the order.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderShippingProductNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "promotion", + "description": "Amount discounted from shipping costs, if any.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "refConnector", + "description": "Shipping company connector identifier code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scheduleFrom", + "description": "Start date of shipping schedule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "scheduleUntil", + "description": "Limit date of shipping schedule.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingFee", + "description": "Shipping fee value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingName", + "description": "The shipping name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shippingTableId", + "description": "Shipping rate table unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "The total value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "volume", + "description": "Order package size.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "weight", + "description": "The order weight, in grams.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderInvoiceNode", + "description": null, + "fields": [ + { + "name": "accessKey", + "description": "The invoice access key.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "invoiceCode", + "description": "The invoice identifier code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "serialDigit", + "description": "The invoice serial digit.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "url", + "description": "The invoice URL.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentNode", + "description": null, + "fields": [ + { + "name": "additionalInfo", + "description": "Additional information for the payment.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "OrderPaymentAdditionalInfoNode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "boleto", + "description": "The boleto information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderPaymentBoletoNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "card", + "description": "The card information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderPaymentCardNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "discount", + "description": "Order discounted value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fees", + "description": "Order additional fees value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installmentValue", + "description": "Value per installment.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installments", + "description": "Number of installments.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Message about payment transaction.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentOption", + "description": "The chosen payment option for the order.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "pix", + "description": "The pix information.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "OrderPaymentPixNode", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Current payment status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total", + "description": "Order total value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderStatusNode", + "description": null, + "fields": [ + { + "name": "changeDate", + "description": "The date when status has changed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "status", + "description": "Order status.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "statusId", + "description": "Status unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeValue", + "description": "Attributes values with variants", + "fields": [ + { + "name": "productVariants", + "description": "Product variants that have the attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ProductVariant", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeSelectionOption", + "description": "Attributes available for the variant products from the given productId.", + "fields": [ + { + "name": "attributeId", + "description": "The id of the attribute.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayType", + "description": "The display type of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": "The values of the attribute.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeSelectionOptionValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "varyByParent", + "description": "If the attributes varies by parent.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMatrix", + "description": null, + "fields": [ + { + "name": "column", + "description": "Information about the column attribute.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AttributeMatrixInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "data", + "description": "The matrix products data. List of rows.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMatrixProduct", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "row", + "description": "Information about the row attribute.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "AttributeMatrixInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BestInstallment", + "description": null, + "fields": [ + { + "name": "discount", + "description": "Wether the installment has discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "displayName", + "description": "The custom display name of the best installment plan option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fees", + "description": "Wether the installment has fees.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of the best installment plan option.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The number of installments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InstallmentPlan", + "description": null, + "fields": [ + { + "name": "displayName", + "description": "The custom display name of this installment plan.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installments", + "description": "List of the installments.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Installment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The name of this installment plan.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PriceTable", + "description": null, + "fields": [ + { + "name": "discountPercentage", + "description": "The amount of discount in percentage.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The id of this price table.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "listPrice", + "description": "The listed regular price of this table.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The current working price of this table.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "WholesalePrices", + "description": null, + "fields": [ + { + "name": "price", + "description": "The wholesale price.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The minimum quantity required for the wholesale price to be applied", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SubscriptionRecurringType", + "description": null, + "fields": [ + { + "name": "days", + "description": "The number of days of the recurring type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": "The recurring type display name.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "recurringTypeId", + "description": "The recurring type id.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellerPrices", + "description": "The prices of the product.", + "fields": [ + { + "name": "installmentPlans", + "description": "List of the possibles installment plans.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellerInstallmentPlan", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "listPrice", + "description": "The listed regular price of the product.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The current working price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "EmailAddress", + "description": "The EmailAddress scalar type constitutes a valid email address, represented as a UTF-8 character sequence. The scalar follows the specification defined by the HTML Spec https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "SCALAR", + "name": "CountryCode", + "description": "String representing a country code", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellerInstallmentPlan", + "description": null, + "fields": [ + { + "name": "displayName", + "description": "The custom display name of this installment plan.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "installments", + "description": "List of the installments.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SellerInstallment", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Installment", + "description": null, + "fields": [ + { + "name": "discount", + "description": "Wether the installment has discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fees", + "description": "Wether the installment has fees.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The number of installments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMatrixProduct", + "description": null, + "fields": [ + { + "name": "available", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "stock", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMatrixInfo", + "description": null, + "fields": [ + { + "name": "displayType", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "name", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "values", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AttributeMatrixRowColumnInfoValue", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeSelectionOptionValue", + "description": null, + "fields": [ + { + "name": "alias", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "available", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "printUrl", + "description": null, + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "selected", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the attribute.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentPixNode", + "description": null, + "fields": [ + { + "name": "qrCode", + "description": "The QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qrCodeExpirationDate", + "description": "The expiration date of the QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "qrCodeUrl", + "description": "The image URL of the QR code.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentBoletoNode", + "description": null, + "fields": [ + { + "name": "digitableLine", + "description": "The digitable line.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "paymentLink", + "description": "The payment link.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentCardNode", + "description": null, + "fields": [ + { + "name": "brand", + "description": "The brand of the card.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "maskedNumber", + "description": "The masked credit card number with only the last 4 digits displayed.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderPaymentAdditionalInfoNode", + "description": null, + "fields": [ + { + "name": "key", + "description": "Additional information key.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "Additional information value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "OrderShippingProductNode", + "description": null, + "fields": [ + { + "name": "distributionCenterId", + "description": "Distribution center unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "The product price.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "productVariantId", + "description": "Variant unique identifier.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Quantity of the given product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "BuyListProduct", + "description": "Contains the id and quantity of a product in the buy list.", + "fields": [ + { + "name": "productId", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "InformationGroupFieldValueNode", + "description": null, + "fields": [ + { + "name": "order", + "description": "The information group field value order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The information group field value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "StocksInput", + "description": "Input to specify the range of stocks, distribution center ID, and distribution center name to return.", + "fields": null, + "inputFields": [ + { + "name": "dcId", + "description": "The distribution center Ids to match.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "dcName", + "description": "The distribution center names to match.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "stock_gte", + "description": "The product stock must be greater than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "stock_lte", + "description": "The product stock must be lesser than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "PricesInput", + "description": "Input to specify the range of prices to return.", + "fields": null, + "inputFields": [ + { + "name": "discount_gte", + "description": "The product discount must be greater than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "discount_lte", + "description": "The product discount must be lesser than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "discounted", + "description": "Return only products where the listed price is more than the price.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price_gte", + "description": "The product price must be greater than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price_lte", + "description": "The product price must be lesser than or equal to.", + "type": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeInput", + "description": "Input to specify which attributes to match.", + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The attribute Ids to match.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "name", + "description": "The attribute name to match.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "type", + "description": "The attribute type to match.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The attribute value to match", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "deliverySchedule", + "description": "A representation of available time slots for scheduling a delivery.", + "fields": [ + { + "name": "date", + "description": "The date of the delivery schedule.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "DateTime", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "periods", + "description": "The list of time periods available for scheduling a delivery.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "period", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShippingProduct", + "description": "The product informations related to the shipping.", + "fields": [ + { + "name": "productVariantId", + "description": "The product unique identifier.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The shipping value related to the product.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "PartnerSubtype", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "OPEN", + "description": "Partner \u0027open\u0027 subtype.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLOSED", + "description": "Partner \u0027closed\u0027 subtype.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "CLIENT", + "description": "Partner \u0027client\u0027 subtype.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "UriKind", + "description": null, + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PRODUCT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "HOTSITE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "REDIRECT", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_FOUND", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "PARTNER", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "BUY_LIST", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutSubscriptionInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "recurringTypeId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "subscriptionGroupId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "CheckoutCustomizationInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "customizationId", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "LoginType", + "description": "The user login type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NEW", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SIMPLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "AUTHENTICATED", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "Gender", + "description": "The customer\u0027s gender.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MALE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "FEMALE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Question", + "description": null, + "fields": [ + { + "name": "answers", + "description": null, + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Answer", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "question", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "questionId", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "SimpleLoginType", + "description": "The simple login type.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NEW", + "description": null, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "SIMPLE", + "description": null, + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "ENUM", + "name": "EntityType", + "description": "Define the entity type of the customer registration.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "PERSON", + "description": "An individual person, a physical person.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "COMPANY", + "description": "Legal entity, a company, business, organization.", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INTERNATIONAL", + "description": "An international person, a legal international entity.", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, + { + "kind": "INPUT_OBJECT", + "name": "InformationGroupValueInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "id", + "description": "The information group field unique identifier.", + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "value", + "description": "The information group field value.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SearchFilterItem", + "description": "Details of a filter value.", + "fields": [ + { + "name": "name", + "description": "The name of the value.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "The quantity of product with this value.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "Answer", + "description": null, + "fields": [ + { + "name": "id", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "period", + "description": "Represents a time period available for scheduling a delivery.", + "fields": [ + { + "name": "end", + "description": "The end time of the time period.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "id", + "description": "The unique identifier of the time period.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Long", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "start", + "description": "The start time of the time period.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AttributeMatrixRowColumnInfoValue", + "description": null, + "fields": [ + { + "name": "printUrl", + "description": null, + "args": [ + { + "name": "height", + "description": "The height of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "width", + "description": "The width of the image the url will return.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": null + } + ], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SellerInstallment", + "description": null, + "fields": [ + { + "name": "discount", + "description": "Wether the installment has discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "fees", + "description": "Wether the installment has fees.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "number", + "description": "The number of installments.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "value", + "description": "The value of the installment.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Decimal", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + } + ], + "directives": [ + { + "name": "skip", + "description": "Directs the executor to skip this field or fragment when the \u0060if\u0060 argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Skipped when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "include", + "description": "Directs the executor to include this field or fragment only when the \u0060if\u0060 argument is true.", + "locations": [ + "FIELD", + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Included when true.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "defaultValue": null + } + ] + }, + { + "name": "defer", + "description": "The \u0060@defer\u0060 directive may be provided for fragment spreads and inline fragments to inform the executor to delay the execution of the current fragment to indicate deprioritization of the current fragment. A query with \u0060@defer\u0060 directive will cause the request to potentially return multiple responses, where non-deferred data is delivered in the initial response and data deferred is delivered in a subsequent response. \u0060@include\u0060 and \u0060@skip\u0060 take precedence over \u0060@defer\u0060.", + "locations": [ + "FRAGMENT_SPREAD", + "INLINE_FRAGMENT" + ], + "args": [ + { + "name": "if", + "description": "Deferred when true.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "label", + "description": "If this argument label has a value other than null, it will be passed on to the result of this defer directive. This label is intended to give client applications a way to identify to which fragment a deferred result belongs to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ] + }, + { + "name": "stream", + "description": "The \u0060@stream\u0060 directive may be provided for a field of \u0060List\u0060 type so that the backend can leverage technology such as asynchronous iterators to provide a partial list in the initial response, and additional list items in subsequent responses. \u0060@include\u0060 and \u0060@skip\u0060 take precedence over \u0060@stream\u0060.", + "locations": [ + "FIELD" + ], + "args": [ + { + "name": "if", + "description": "Streamed when true.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "initialCount", + "description": "The initial elements that shall be send down to the consumer.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "defaultValue": "0" + }, + { + "name": "label", + "description": "If this argument label has a value other than null, it will be passed on to the result of this stream directive. This label is intended to give client applications a way to identify to which fragment a streamed result belongs to.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ] + }, + { + "name": "deprecated", + "description": "The @deprecated directive is used within the type system definition language to indicate deprecated portions of a GraphQL service\u2019s schema,such as deprecated fields on a type or deprecated enum values.", + "locations": [ + "FIELD_DEFINITION", + "ENUM_VALUE" + ], + "args": [ + { + "name": "reason", + "description": "Deprecations include a reason for why it is deprecated, which is formatted using Markdown syntax (as specified by CommonMark).", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": "\u0022No longer supported.\u0022" + } + ] + }, + { + "name": "authorize", + "description": null, + "locations": [ + "SCHEMA", + "OBJECT", + "FIELD_DEFINITION" + ], + "args": [ + { + "name": "apply", + "description": "Defines when when the resolver shall be executed.By default the resolver is executed after the policy has determined that the current user is allowed to access the field.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ApplyPolicy", + "ofType": null + } + }, + "defaultValue": "BEFORE_RESOLVER" + }, + { + "name": "policy", + "description": "The name of the authorization policy that determines access to the annotated resource.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "roles", + "description": "Roles that are allowed to access the annotated resource.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + } + ] + }, + { + "name": "specifiedBy", + "description": "The \u0060@specifiedBy\u0060 directive is used within the type system definition language to provide a URL for specifying the behavior of custom scalar definitions.", + "locations": [ + "SCALAR" + ], + "args": [ + { + "name": "url", + "description": "The specifiedBy URL points to a human-readable specification. This field will only read a result for scalar types.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ] + } + ] + } + } +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-novo-produto.openapi.json b/wake/utils/openapi/adiciona-novo-produto.openapi.json new file mode 100644 index 000000000..ab5d4f123 --- /dev/null +++ b/wake/utils/openapi/adiciona-novo-produto.openapi.json @@ -0,0 +1,372 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos": { + "post": { + "summary": "Adiciona novo produto", + "description": "Método que insere um produto na base", + "operationId": "adiciona-novo-produto", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idPaiExterno": { + "type": "string", + "description": "Representa o ProdutoId agrupador por variante (optional)" + }, + "idVinculoExterno": { + "type": "string", + "description": "Representa o ParentId agrupador por parent (optional)" + }, + "sku": { + "type": "string", + "description": "(Max Length: 50) Sku do produto" + }, + "nome": { + "type": "string", + "description": "(Max Length: 300) Nome do produto variante" + }, + "nomeProdutoPai": { + "type": "string", + "description": "Nome do produto (pai do variante) (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Tipo de exibição da matriz de atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "contraProposta": { + "type": "boolean", + "description": "Se o produto aceita contra proposta (optional)" + }, + "fabricante": { + "type": "string", + "description": "(Max Length: 100) Nome do fabricante" + }, + "autor": { + "type": "string", + "description": "(Max Length: 500) Nome do autor (optional)" + }, + "editora": { + "type": "string", + "description": "(Max Length: 100) Nome da editora (optional)" + }, + "colecao": { + "type": "string", + "description": "(Max Length: 100) Nome da coleção (optional)" + }, + "genero": { + "type": "string", + "description": "(Max Length: 100) Nome do gênero (optional)" + }, + "precoCusto": { + "type": "number", + "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto variante (optional)", + "format": "int32" + }, + "valido": { + "type": "boolean", + "description": "Define se um produto variante é valido ou não" + }, + "exibirSite": { + "type": "boolean", + "description": "Define se um produto deve ser exibido no site" + }, + "freteGratis": { + "type": "string", + "description": "Define a qual regra de calculo de frete o produto vai pertencer", + "enum": [ + "Sempre", + "Nunca", + "Neutro", + "Desconsiderar_Regras" + ] + }, + "trocaGratis": { + "type": "boolean", + "description": "Define se o produto variante tem troca grátis (optional)" + }, + "peso": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g).", + "format": "double" + }, + "altura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", + "format": "double" + }, + "comprimento": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", + "format": "double" + }, + "largura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", + "format": "double" + }, + "garantia": { + "type": "integer", + "description": "Define se o produto variante tem garantia (optional)", + "format": "int32" + }, + "isTelevendas": { + "type": "boolean", + "description": "Define se o produto contém televendas (optional)" + }, + "ean": { + "type": "string", + "description": "(Max Length: 25) EAN do produto variante (optional)" + }, + "localizacaoEstoque": { + "type": "string", + "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" + }, + "listaAtacado": { + "type": "array", + "description": "Dados de atacado do produto variante (optional)", + "items": { + "properties": { + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade para compra de atacado", + "format": "int32" + } + }, + "type": "object" + } + }, + "estoque": { + "type": "array", + "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + }, + "listaAtributos": { + "type": "array", + "description": "Lista de atributos do produto", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "(Max Length: 100) - Define o nome do atributo" + }, + "valor": { + "type": "string", + "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" + }, + "exibir": { + "type": "boolean", + "description": "Define se o atributo deverá ser exibido" + } + }, + "type": "object" + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Quantidade máxima de compra do produto variante (optional)", + "format": "int32" + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "description": "Quantidade mínima de compra do produto variante (optional)", + "format": "int32" + }, + "condicao": { + "type": "string", + "description": "Condição do produto variante (optional)", + "enum": [ + "Novo", + "Usado", + "Renovado", + "Danificado" + ] + }, + "urlVideo": { + "type": "string", + "description": "Url do vídeo do Produto (optional)" + }, + "spot": { + "type": "boolean", + "description": "Se o produto aparece no Spot (optional)" + }, + "paginaProduto": { + "type": "boolean", + "description": "Se o produto aparece na Url (optional)" + }, + "marketplace": { + "type": "boolean", + "description": "Se o produto aparece no Marketplace (optional)" + }, + "somenteParceiros": { + "type": "boolean", + "description": "Se o produto aparece somente nos Parceiros (optional)" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deve ser agrupado pelo EAN (optional)" + }, + "prazoValidade": { + "type": "integer", + "description": "Prazo de validade ou consumo do produto (optional)", + "format": "int32" + }, + "consumo": { + "type": "object", + "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail.", + "properties": { + "quantidadeDias": { + "type": "integer", + "description": "Quantidade de Dias (optional)", + "format": "int32" + }, + "enviarEmail": { + "type": "boolean", + "description": "Enviar e-mail (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do produto variante gerado": { + "value": "Id do produto variante gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c2f227aee7e0002715f279" +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json b/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json new file mode 100644 index 000000000..488f07ffc --- /dev/null +++ b/wake/utils/openapi/adiciona-novos-atacarejos.openapi.json @@ -0,0 +1,201 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/atacarejo": { + "post": { + "summary": "Adiciona novos Atacarejos", + "description": "", + "operationId": "adiciona-novos-atacarejos", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Atacarejos (optional)", + "items": { + "properties": { + "precoAtacado": { + "type": "number", + "description": "Preço atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c492bb89b317004423454c" +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json b/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json new file mode 100644 index 000000000..4ea266373 --- /dev/null +++ b/wake/utils/openapi/adiciona-o-vinculo-entre-um-produto-e-uma-categoria.openapi.json @@ -0,0 +1,150 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/categorias": { + "post": { + "summary": "Adiciona o vínculo entre um produto e uma categoria", + "description": "Adiciona o vínculo entre um produto e uma categoria com base na lista enviada", + "operationId": "adiciona-o-vinculo-entre-um-produto-e-uma-categoria", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "categoriaPrincipalId": { + "type": "integer", + "description": "Id da Categoria Principal (optional)", + "format": "int32" + }, + "listaCategoriaId": { + "type": "array", + "description": "Id da categoria a qual o produto deverá ser vinculado (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c44eff366cb40080f1cdc0" +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json new file mode 100644 index 000000000..4b3c8e8b2 --- /dev/null +++ b/wake/utils/openapi/adiciona-um-vinculo-entre-usuario-e-parceiro.openapi.json @@ -0,0 +1,132 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/parceiro": { + "post": { + "summary": "Adiciona um vínculo entre usuário e parceiro", + "description": "", + "operationId": "adiciona-um-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja vincular", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + }, + "vinculoVitalicio": { + "type": "boolean", + "description": "Vinculo vitalício (optional)" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do vinculo entre usuário e parceiro (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do vinculo entre usuário e parceiro (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Usuário vinculado com o parceiro com sucesso": { + "value": "Usuário vinculado com o parceiro com sucesso" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de920520b8a600a54dfd77" +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json b/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json new file mode 100644 index 000000000..c571d7545 --- /dev/null +++ b/wake/utils/openapi/adiciona-uma-nova-imagem-vinculada-a-um-produto.openapi.json @@ -0,0 +1,182 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/imagens": { + "post": { + "summary": "Adiciona uma nova imagem vinculada a um produto", + "description": "", + "operationId": "adiciona-uma-nova-imagem-vinculada-a-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "tipoRetorno", + "in": "query", + "description": "Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", + "schema": { + "type": "string", + "enum": [ + "ListaIds", + "Booleano" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com as imagens do produto no formato base 64 (optional)", + "items": { + "properties": { + "base64": { + "type": "string", + "description": "Imagem do produto em base64" + }, + "formato": { + "type": "string", + "description": "JPG ou PNG" + }, + "exibirMiniatura": { + "type": "boolean", + "description": "Se a imagem será apresentada como miniatura" + }, + "estampa": { + "type": "boolean", + "description": "Se a imagem será apresentada como estampa" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação da imagem", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c469681f965e03abf18962" +} \ No newline at end of file diff --git a/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json b/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json new file mode 100644 index 000000000..e307d5058 --- /dev/null +++ b/wake/utils/openapi/adiciona-uma-nova-informacao.openapi.json @@ -0,0 +1,185 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/informacoes": { + "post": { + "summary": "Adiciona uma nova informação", + "description": "", + "operationId": "adiciona-uma-nova-informacao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "tipoRetorno", + "in": "query", + "description": "Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano", + "schema": { + "type": "string", + "enum": [ + "Id", + "Booleano" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo da informação (optional)" + }, + "texto": { + "type": "string", + "description": "Texto da informação (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Informação se o produto variante está visível no site." + }, + "tipoInformacao": { + "type": "string", + "description": "Tipo de informação do produto (optional)", + "enum": [ + "Informacoes", + "Beneficios", + "Especificacoes", + "DadosTecnicos", + "Composicao", + "ModoDeUsar", + "Cuidados", + "ItensInclusos", + "Dicas", + "Video", + "Descricao", + "ValorReferente", + "PopUpReferente", + "Prescricao", + "TabelaDeMedidas", + "Spot", + "Sinopse", + "Carrinho" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c44160fb4198002fd91e72" +} \ No newline at end of file diff --git a/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json b/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json new file mode 100644 index 000000000..46b8b0d04 --- /dev/null +++ b/wake/utils/openapi/altera-a-data-de-recorrencia-de-uma-assinatura.openapi.json @@ -0,0 +1,150 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}/proximaRecorrencia": { + "put": { + "summary": "Altera a data de recorrência de uma assinatura", + "description": "", + "operationId": "altera-a-data-de-recorrencia-de-uma-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Identificador da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "proximaRecorrencia": { + "type": "string", + "description": "Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:63359f8f907ca9000f334681" +} \ No newline at end of file diff --git a/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json b/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json new file mode 100644 index 000000000..f3e25749b --- /dev/null +++ b/wake/utils/openapi/altera-o-status-de-um-portfolio.openapi.json @@ -0,0 +1,124 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}/status": { + "put": { + "summary": "Altera o status de um portfolio", + "description": "", + "operationId": "altera-o-status-de-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Status do portfolio: true ou false", + "properties": { + "ativo": { + "type": "boolean", + "description": "Novo status do portfolio" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef4ae0b7a1d003587bf7d" +} \ No newline at end of file diff --git a/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json b/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json new file mode 100644 index 000000000..e957e9c42 --- /dev/null +++ b/wake/utils/openapi/aprova-um-cadastro-de-usuario.openapi.json @@ -0,0 +1,152 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/autorizar": { + "put": { + "summary": "Aprova um cadastro de usuário", + "description": "Operação realizada com ou sem sucesso para os usuários", + "operationId": "aprova-um-cadastro-de-usuario", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Tipo de Identificador", + "schema": { + "type": "string", + "enum": [ + "UsuarioId", + "Email" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Usuários", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Identificador" + }, + "aprovado": { + "type": "boolean", + "description": "Status de aprovação" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuariosAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuariosNaoAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62decb9a9c6884004b017caf" +} \ No newline at end of file diff --git a/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json b/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json new file mode 100644 index 000000000..3acb6aa4d --- /dev/null +++ b/wake/utils/openapi/atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}/produtos": { + "put": { + "summary": "Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request", + "description": "", + "operationId": "atauliza-lista-de-produtos-vinculados-a-um-evento-removendo-os-itens-vinculados-anteriormente-e-mantendo-apenas-os-enviados-pelo-request", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtosVariante": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c46678273b800036c3ceaa" +} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json new file mode 100644 index 000000000..72bb197c3 --- /dev/null +++ b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario.openapi.json @@ -0,0 +1,127 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/enderecos/{enderecoId}/ativar": { + "put": { + "summary": "Ativa ou desativa um endereço de um usuário com base no e-mail do usuário", + "description": "", + "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja alterar o status do endereço", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço que se deseja alterar o status", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status do endereço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de84e2ad1c94005e93c49e" +} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json new file mode 100644 index 000000000..30bf02f77 --- /dev/null +++ b/wake/utils/openapi/ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario.openapi.json @@ -0,0 +1,128 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}/enderecos/{enderecoId}/ativar": { + "put": { + "summary": "Ativa ou desativa um endereço de um usuário com base no id do usuário", + "description": "", + "operationId": "ativa-ou-desativa-um-endereco-de-um-usuario-com-base-no-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status do endereço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de7e88dd8ea90037b5b279" +} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json new file mode 100644 index 000000000..56a3b39ea --- /dev/null +++ b/wake/utils/openapi/ativa-ou-desativa-um-frete.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}/Ativo": { + "put": { + "summary": "Ativa ou Desativa um frete", + "description": "Frete atualizado com sucesso", + "operationId": "ativa-ou-desativa-um-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status para atualização do contrato de frete" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d2bde9995201369a43c5" +} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json b/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json new file mode 100644 index 000000000..2e8912d3b --- /dev/null +++ b/wake/utils/openapi/ativa-ou-desativa-um-seller.openapi.json @@ -0,0 +1,118 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/{resellerId}/status": { + "put": { + "summary": "Ativa ou desativa um Seller", + "description": "", + "operationId": "ativa-ou-desativa-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status do seller (ativo / inativo)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d549c7a3038d00f877dfc6" +} \ No newline at end of file diff --git a/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json b/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json new file mode 100644 index 000000000..608604555 --- /dev/null +++ b/wake/utils/openapi/ativa-ou-inativa-uma-inscricao.openapi.json @@ -0,0 +1,126 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/inscricao/{inscricaoId}/Ativar": { + "put": { + "summary": "Ativa ou inativa uma inscrição", + "description": "", + "operationId": "ativa-ou-inativa-uma-inscricao", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada)" + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a atualização" + }, + "observacao": { + "type": "string", + "description": "Observação que deseje fazer com relação a ativação/desativação da inscrição (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb53224cf363008f84f170" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json b/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json new file mode 100644 index 000000000..d9e9091b3 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-ativacao-automatica-de-produtos-de-um-seller.openapi.json @@ -0,0 +1,118 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/{resellerId}/ativacaoAutomaticaProdutos": { + "put": { + "summary": "Atualiza a ativação automática de produtos de um Seller", + "description": "", + "operationId": "atualiza-a-ativacao-automatica-de-produtos-de-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status da ativação automática de produtos" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d54a2109a9600022d27023" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json b/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json new file mode 100644 index 000000000..8d075480d --- /dev/null +++ b/wake/utils/openapi/atualiza-a-autonomia-de-um-seller.openapi.json @@ -0,0 +1,118 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/{resellerId}/autonomia": { + "put": { + "summary": "Atualiza a autonomia de um Seller", + "description": "", + "operationId": "atualiza-a-autonomia-de-um-seller", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status da autonomia do seller" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d54963a605cb00870d19be" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json b/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json new file mode 100644 index 000000000..e2e187f22 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-comunicacao-de-um-usuario-via-newsletter.openapi.json @@ -0,0 +1,117 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/comunicacao": { + "put": { + "summary": "Atualiza a comunicação de um usuário via newsletter", + "description": "", + "operationId": "atualiza-a-comunicacao-de-um-usuario-via-newsletter", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "recebimentoNewsletter": { + "type": "boolean", + "description": "Novo status da comunicação via new ajuste realisletter" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dea54e6d3de500a2e0e173" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json b/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json new file mode 100644 index 000000000..e2b88275b --- /dev/null +++ b/wake/utils/openapi/atualiza-a-data-de-cadastro-de-um-produto.openapi.json @@ -0,0 +1,514 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/DataCadastro": { + "put": { + "summary": "Atualiza a data de cadastro de um produto", + "description": "Atualiza a data de cadastro um produto com base nos dados enviados", + "operationId": "atualiza-a-data-de-cadastro-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "dataCadastro": { + "type": "string", + "description": "Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "\tProduto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c330bc1dae71001399ee9d" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json new file mode 100644 index 000000000..ec20f8219 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-data-de-entrega-do-pedido.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento": { + "put": { + "summary": "Atualiza a data de entrega do pedido", + "description": "", + "operationId": "atualiza-a-data-de-entrega-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados do rastreamento", + "properties": { + "rastreamento": { + "type": "string", + "description": "Código de verificação do transporte do produto" + }, + "dataEntrega": { + "type": "string", + "description": "Data que a entrega foi realizada" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb124393006a00fd45eba5" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json b/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json new file mode 100644 index 000000000..28aa7de03 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/Parceiros": { + "put": { + "summary": "Atualiza a exibição do banner em parceiros, se deve ser em todos ou não", + "description": "", + "operationId": "atualiza-a-exibicao-do-banner-em-parceiros-se-deve-ser-em-todos-ou-nao", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Exibição do banner em parceiros" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a777db37590c02362b7353" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json b/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json new file mode 100644 index 000000000..14ff8becd --- /dev/null +++ b/wake/utils/openapi/atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/hotsites": { + "put": { + "summary": "Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não", + "description": "", + "operationId": "atualiza-a-exibicao-do-banner-nos-hotsites-se-deve-ser-em-todos-ou-nao", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Id do banner", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Exibição do banner nos hotsites" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7680c2436ab012aa5657d" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json b/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json new file mode 100644 index 000000000..a9860dc5f --- /dev/null +++ b/wake/utils/openapi/atualiza-a-imagem-de-estampa-do-produto.openapi.json @@ -0,0 +1,142 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/imagens/estampa": { + "put": { + "summary": "Atualiza a imagem de estampa do produto", + "description": "", + "operationId": "atualiza-a-imagem-de-estampa-do-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idImagem": { + "type": "integer", + "description": "Id da imagem que será marcada como estampa", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c46cbbe579280049bdc972" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json b/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json new file mode 100644 index 000000000..5b2ea8d2c --- /dev/null +++ b/wake/utils/openapi/atualiza-a-imagem-do-banner.openapi.json @@ -0,0 +1,172 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/Imagem": { + "put": { + "summary": "Atualiza a imagem do banner", + "description": "", + "operationId": "atualiza-a-imagem-do-banner", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Id do banner", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "urlImagem": { + "type": "string", + "description": "URL da Imagem (optional)" + }, + "Imagem": { + "type": "object", + "description": "Informações para atualizar a imagem (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a778ac0e2537080d7a0922" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json new file mode 100644 index 000000000..cde76c427 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-situacao-de-uma-assinatura-especifica.openapi.json @@ -0,0 +1,141 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}": { + "put": { + "summary": "Atualiza a situação de uma assinatura específica", + "description": "", + "operationId": "atualiza-a-situacao-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "description": "Id do endereço (optional)", + "format": "int32" + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "description": "Id do cartão de crédito do usuário (optional)", + "format": "int32" + }, + "periodoRecorrencia": { + "type": "string", + "description": "Período Recorrência (optional)" + }, + "situacaoAssinatura": { + "type": "string", + "description": "Situação da Assinatura (optional)", + "enum": [ + "Ativa", + "Pausada", + "Cancelada" + ] + }, + "cupom": { + "type": "string", + "description": "Cupom (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a72072e64d1e001eb41c9a" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json new file mode 100644 index 000000000..4cac23494 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-situacao-do-status-de-um-produto-do-pedido.openapi.json @@ -0,0 +1,179 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/{produtoVarianteId}/status": { + "put": { + "summary": "Atualiza a situação do status de um produto do pedido", + "description": "", + "operationId": "atualiza-a-situacao-do-status-de-um-produto-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Dados da situação do produto (optional)", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do produto", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade de produtos do centro de distribuição", + "format": "int32" + }, + "situacaoPedidoProdutoId": { + "type": "integer", + "description": "Novo status da situação do produto (são os mesmo status do pedido)", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb2ee068809f00213f0330" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json b/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json new file mode 100644 index 000000000..75b22ed17 --- /dev/null +++ b/wake/utils/openapi/atualiza-a-situacao-do-status-do-pedido.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/status": { + "put": { + "summary": "Atualiza a situação do status do pedido", + "description": "", + "operationId": "atualiza-a-situacao-do-status-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do Pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Id da situação do pedido", + "properties": { + "id": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb0f0892734202f646b177" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json b/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json new file mode 100644 index 000000000..10d3d2bb9 --- /dev/null +++ b/wake/utils/openapi/atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento.openapi.json @@ -0,0 +1,154 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}/produtos/recebido": { + "put": { + "summary": "Atualiza o campo Recebido de um produto vinculado a um evento", + "description": "", + "operationId": "atualiza-o-campo-recebido-de-um-produto-vinculado-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante (optional)", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se o produto foi recebido fora da lista (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac8eb4b341de004e8ceb0a" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json b/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json new file mode 100644 index 000000000..480e49719 --- /dev/null +++ b/wake/utils/openapi/atualiza-o-estoque-de-varios-produtos.openapi.json @@ -0,0 +1,238 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/estoques": { + "put": { + "summary": "Atualiza o estoque de vários produtos", + "description": "Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", + "operationId": "atualiza-o-estoque-de-varios-produtos", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do estoque (optional)", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Valor único utilizado para identificar o produto" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto", + "format": "int32" + }, + "listaEstoque": { + "type": "array", + "description": "Lista com os dados da atualização do estoque", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c3322231eb6900649e2013" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json b/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json new file mode 100644 index 000000000..d2632c855 --- /dev/null +++ b/wake/utils/openapi/atualiza-o-frete-de-todos-os-produtos-de-um-pedido.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/changeseller": { + "put": { + "summary": "Atualiza o frete de todos os produtos de um pedido", + "description": "", + "operationId": "atualiza-o-frete-de-todos-os-produtos-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados de cotação e responsável", + "properties": { + "cotacao": { + "type": "string", + "description": "ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes" + }, + "responsavel": { + "type": "string", + "description": "Responsável pela cotação" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:641b388b5760451595218ec0" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json b/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json new file mode 100644 index 000000000..32964d54d --- /dev/null +++ b/wake/utils/openapi/atualiza-o-preco-de-varios-produtos.openapi.json @@ -0,0 +1,209 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/precos": { + "put": { + "summary": "Atualiza o preço de vários produtos", + "description": "Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição", + "operationId": "atualiza-o-preco-de-varios-produtos", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do preço (optional)", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Identificador do produto (ProdutoVarianteId ou SKU)" + }, + "precoCusto": { + "type": "number", + "description": "Preço de custo do produto variante", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "\"PrecoDe\" do produto variante", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "\"PrecoPor\" do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão)", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c43202750530009e4c1fad" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json b/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json new file mode 100644 index 000000000..00abc58db --- /dev/null +++ b/wake/utils/openapi/atualiza-o-status-de-uma-avaliacao-de-um-produto-variante.openapi.json @@ -0,0 +1,154 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtoavaliacao/{produtoAvaliacaoId}/status": { + "put": { + "summary": "Atualiza o status de uma avaliação de um produto variante", + "description": "", + "operationId": "atualiza-o-status-de-uma-avaliacao-de-um-produto-variante", + "parameters": [ + { + "name": "produtoAvaliacaoId", + "in": "path", + "description": "Identificador de uma Avaliação de um produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "string", + "description": "Status para a avaliação", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d06b923fea280086f8709e" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json b/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json new file mode 100644 index 000000000..76b72c2d0 --- /dev/null +++ b/wake/utils/openapi/atualiza-o-status-do-banner-pelo-id.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/status": { + "put": { + "summary": "Atualiza o status do banner pelo id", + "description": "", + "operationId": "atualiza-o-status-do-banner-pelo-id", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Status para qual deve ir o baner: Ativo (true) ou Inativo (false)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a73da240034e0086aee3de" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json b/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json new file mode 100644 index 000000000..09677179b --- /dev/null +++ b/wake/utils/openapi/atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/status": { + "put": { + "summary": "Atualiza o status do hotsite, sendo ativo (true) ou inativo (false)", + "description": "", + "operationId": "atualiza-o-status-do-hotsite-sendo-ativo-true-ou-inativo-false", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser atualizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ativo": { + "type": "boolean", + "description": "Status para qual o hotsite indicado deve ir" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a89b23b696e70057bec544" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json b/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json new file mode 100644 index 000000000..dfc9c5ccc --- /dev/null +++ b/wake/utils/openapi/atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}/AlterarStatus": { + "put": { + "summary": "Atualiza o status do tipo de evento, ativando-o ou inativando-o", + "description": "", + "operationId": "atualiza-o-status-do-tipo-de-evento-ativando-o-ou-inativando-o", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62cedc03ecf222001a0b82db" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json b/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json new file mode 100644 index 000000000..2a364e6f5 --- /dev/null +++ b/wake/utils/openapi/atualiza-o-tipo-evento.openapi.json @@ -0,0 +1,203 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}": { + "put": { + "summary": "Atualiza o tipo evento", + "description": "", + "operationId": "atualiza-o-tipo-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Tipo de Evento" + }, + "tipoEntrega": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "tipoDisponibilizacao": { + "type": "string", + "description": "Disponibilização do Tipo de Evento", + "enum": [ + "DisponibilizacaoDeCreditos", + "DisponibilizacaoDeProdutos", + "Todos" + ] + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "description": "Permissão para remoção automática de produtos" + }, + "corHexTituloInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o titulo de informações" + }, + "corHexCorpoInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o corpo de informações" + }, + "numeroAbasInformacoes": { + "type": "integer", + "description": "Número de abas de informações, podendo ser de 1 a 2", + "format": "int32" + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "description": "Quantidade de dias para que o evento expire", + "format": "int32" + }, + "numeroLocaisEvento": { + "type": "integer", + "description": "Quantidade de locais do evento", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Informa se o evento está ativo ou inativo" + }, + "disponivel": { + "type": "boolean", + "description": "Informa a disponibilidade do evento" + }, + "tipoBeneficiarioFrete": { + "type": "string", + "description": "O beneficiário do frete", + "enum": [ + "DonodaLista", + "Convidado" + ] + }, + "imagemLogoEvento": { + "type": "string", + "description": "Imagem da logo do evento em base64" + }, + "sugestaoProdutos": { + "type": "array", + "description": "Produtos Sugeridos para este evento (optional)", + "items": { + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Id do tipo de evento", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ced1bfb6ef560e1f64f7df" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json b/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json new file mode 100644 index 000000000..1c98485ee --- /dev/null +++ b/wake/utils/openapi/atualiza-os-dados-de-um-hotsite-existente.openapi.json @@ -0,0 +1,286 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}": { + "put": { + "summary": "Atualiza os dados de um hotsite existente", + "description": "", + "operationId": "atualiza-os-dados-de-um-hotsite-existente", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser atualizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do hotsite" + }, + "dataInicio": { + "type": "string", + "description": "Data/hora em que o hotsite começará a ser exibido (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", + "format": "date" + }, + "url": { + "type": "string", + "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" + }, + "tamanhoPagina": { + "type": "integer", + "description": "Informe o número de produtos que deve ser exibido por página", + "format": "int32" + }, + "templateId": { + "type": "integer", + "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", + "format": "int32" + }, + "ordenacao": { + "type": "string", + "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", + "enum": [ + "Nenhuma", + "NomeCrescente", + "NomeDecrescente", + "Lancamento", + "MenorPreco", + "MaiorPreco", + "MaisVendidos", + "MaioresDescontos", + "Aleatorio", + "MenorEstoque", + "MaiorEstoque" + ] + }, + "listaProdutos": { + "type": "object", + "description": "Produtos que devem aparecer no hotsite", + "properties": { + "expressao": { + "type": "string", + "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" + }, + "produtos": { + "type": "array", + "description": "Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Identificador do produto a ser mostrado no hotsite", + "format": "int32" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação do produto (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "seo": { + "type": "object", + "description": "Dados de seo", + "properties": { + "titulo": { + "type": "string", + "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" + }, + "metas": { + "type": "array", + "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", + "items": { + "properties": { + "conteudo": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "nome": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "httpEquiv": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "scheme": { + "type": "string", + "description": "Informe os dados da Metatag" + } + }, + "type": "object" + } + } + } + }, + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem vinculados ao hotsite", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + }, + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + }, + "ativo": { + "type": "boolean", + "description": "Status do hotsite (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b2051f846cfe08b0bc5625" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json b/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json new file mode 100644 index 000000000..8b2fa936b --- /dev/null +++ b/wake/utils/openapi/atualiza-os-produtos-sugeridos-de-um-tipo-de-evento.openapi.json @@ -0,0 +1,128 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}/produtos": { + "put": { + "summary": "Atualiza os produtos sugeridos de um tipo de evento", + "description": "", + "operationId": "atualiza-os-produtos-sugeridos-de-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtos": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ced07e60f1270ffa5b7ea3" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json b/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json new file mode 100644 index 000000000..077f754aa --- /dev/null +++ b/wake/utils/openapi/atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado.openapi.json @@ -0,0 +1,195 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/precos/lote": { + "put": { + "summary": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado", + "description": "Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição", + "operationId": "atualiza-para-o-mesmo-preco-todos-os-variantes-de-um-produto-encontrado-com-o-sku-informado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista com os dados da atualização do preço por lote", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "Identificador do produto (SKU)" + }, + "precoCusto": { + "type": "number", + "description": "Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "\"PrecoDe\" do produto variante", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "\"PrecoPor\" do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"produtosNaoAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosAtualizados\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtosNaoAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosAtualizados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4368c2ddf2500137b6405" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json b/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json new file mode 100644 index 000000000..383ed7488 --- /dev/null +++ b/wake/utils/openapi/atualiza-rastreamento-completo-com-os-dados-da-nf.openapi.json @@ -0,0 +1,197 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}": { + "put": { + "summary": "Atualiza rastreamento completo (com os dados da N.F.)", + "description": "", + "operationId": "atualiza-rastreamento-completo-com-os-dados-da-nf", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoId", + "in": "path", + "description": "Id do Pedido Rastreamento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento", + "properties": { + "notaFiscal": { + "type": "string", + "description": "Número da nota fiscal" + }, + "cfop": { + "type": "integer", + "description": "Código Fiscal de Operações e Prestações", + "format": "int32" + }, + "dataEnviado": { + "type": "string", + "description": "Data Envio" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de Acesso NFE" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + }, + "transportadora": { + "type": "string", + "description": "Transportadora (optional)" + }, + "dataEntrega": { + "type": "string", + "description": "Data da entrega (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb138db31f30003d9e4166" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json b/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json new file mode 100644 index 000000000..a9b293b98 --- /dev/null +++ b/wake/utils/openapi/atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf.openapi.json @@ -0,0 +1,200 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}": { + "put": { + "summary": "Atualiza rastreamento de produto completo (com os dados da N.F.)", + "description": "", + "operationId": "atualiza-rastreamento-de-produto-completo-com-os-dados-da-nf", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "notaFiscal": { + "type": "string", + "description": "Nota Fiscal" + }, + "cfop": { + "type": "integer", + "description": "CFOP", + "format": "int32" + }, + "dataEnviado": { + "type": "string", + "description": "Data Enviado", + "format": "date" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de acesso NFE" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + }, + "transportadora": { + "type": "string", + "description": "Transportadora (optional)" + }, + "dataEntrega": { + "type": "string", + "description": "Data da entrega (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bd93a23555a702b80cc676" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json new file mode 100644 index 000000000..e44896060 --- /dev/null +++ b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1.openapi.json @@ -0,0 +1,182 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}/parcial": { + "put": { + "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", + "description": "", + "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento-1", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento Produto", + "properties": { + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de Rastreamento (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb2daa0958bf004df9bb6b" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json new file mode 100644 index 000000000..64916ff74 --- /dev/null +++ b/wake/utils/openapi/atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento.openapi.json @@ -0,0 +1,172 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento/{pedidoRastreamentoId}/parcial": { + "put": { + "summary": "Atualiza rastreamento parcial (Rastreamento e UrlRastreamento)", + "description": "", + "operationId": "atualiza-rastreamento-parcial-rastreamento-e-urlrastreamento", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoId", + "in": "path", + "description": "Id do Pedido Rastreamento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto Pedido Rastreamento", + "properties": { + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de Rastreamento (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb1601cbcb18001a387394" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-atacarejo.openapi.json b/wake/utils/openapi/atualiza-um-atacarejo.openapi.json new file mode 100644 index 000000000..ec8d5dff4 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-atacarejo.openapi.json @@ -0,0 +1,176 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { + "put": { + "summary": "Atualiza um Atacarejo", + "description": "", + "operationId": "atualiza-um-atacarejo", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "SKU ou Id do Produto Variante", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "precoAtacado": { + "type": "number", + "description": "Preço atacado (optional)", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Resultado da Atualização do Atacarejo": { + "value": "Resultado da Atualização do Atacarejo" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4972ef8681e009e2f55cf" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-atributo.openapi.json b/wake/utils/openapi/atualiza-um-atributo.openapi.json new file mode 100644 index 000000000..4d52c8918 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-atributo.openapi.json @@ -0,0 +1,175 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/atributos/{nome}": { + "put": { + "summary": "Atualiza um atributo", + "description": "", + "operationId": "atualiza-um-atributo", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do atributo (optional)" + }, + "tipo": { + "type": "string", + "description": "Tipo do atributo (optional)", + "enum": [ + "Selecao", + "Filtro", + "Comparacao", + "Configuracao", + "ExclusivoGoogle" + ] + }, + "tipoExibicao": { + "type": "string", + "description": "Tipo de exibição (optional)", + "enum": [ + "Combo", + "Div", + "DivComCor", + "DivComFotoDoProdutoVariante", + "Javascript" + ] + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do atributo (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0ef671d1a44001a416495" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-banner-existente.openapi.json b/wake/utils/openapi/atualiza-um-banner-existente.openapi.json new file mode 100644 index 000000000..2e804bb3b --- /dev/null +++ b/wake/utils/openapi/atualiza-um-banner-existente.openapi.json @@ -0,0 +1,348 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}": { + "put": { + "summary": "Atualiza um banner existente", + "description": "", + "operationId": "atualiza-um-banner-existente", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve acontecer a atualização", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do banner" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do banner", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de termino de exibição do banner (optional)", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Banner ativo/inativo (optional)" + }, + "detalhe": { + "type": "object", + "description": "Detalhes do banner", + "properties": { + "posicionamentoId": { + "type": "integer", + "description": "Local de posicionamento do banner", + "format": "int32" + }, + "imagemBanner": { + "type": "object", + "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + }, + "urlBanner": { + "type": "string", + "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" + }, + "ordemExibicao": { + "type": "integer", + "description": "Ordem de exibição do banner (optional)", + "format": "int32" + }, + "abrirLinkNovaAba": { + "type": "boolean", + "description": "Se o banner deve ou não abrir em nova aba (optional)" + }, + "largura": { + "type": "integer", + "description": "Largura do banner em pixels (optional)", + "format": "int32" + }, + "altura": { + "type": "integer", + "description": "Altura do banner em pixels (optional)", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Title da imagem do banner (optional)" + }, + "urlClique": { + "type": "string", + "description": "Url de destino para quando o usuário clicar no Banner (optional)" + }, + "urlBannerAlternativo": { + "type": "string", + "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" + }, + "textoAlternativo": { + "type": "string", + "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" + } + } + }, + "diasExibicao": { + "type": "object", + "description": "Dias da semana que o banner deverá ser exibido (optional)", + "properties": { + "todosDias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" + }, + "domingo": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no domingo" + }, + "segunda": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na segunda" + }, + "terca": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na terça" + }, + "quarta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quarta" + }, + "quinta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quinta" + }, + "sexta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na sexta" + }, + "sabado": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no sábado" + } + } + }, + "apresentacao": { + "type": "object", + "description": "Apresentação do banner (optional)", + "properties": { + "exibirNoSite": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todo o site" + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas as buscas" + }, + "naoExibirEmBuscas": { + "type": "boolean", + "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "termosBusca": { + "type": "string", + "description": "Termos que o banner será exibido na busca" + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "listaHotsites": { + "type": "object", + "description": "Em quais hotsites o banner deve ser exibido", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" + }, + "hotsites": { + "type": "array", + "description": "Lista de hotsite's que o banner será exibido", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + }, + "listaParceiros": { + "type": "object", + "description": "Em quais parceiros o banner deve ser exibido", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" + }, + "parceiros": { + "type": "array", + "description": "Lista de parceiros que o banner será exibido", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a3536c05e24b00790f0fb6" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json new file mode 100644 index 000000000..ef633b1b2 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-campo-de-cadastro-personalizado-pelo-id.openapi.json @@ -0,0 +1,127 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/camposcadastropersonalizado/{camposcadastropersonalizadoId}": { + "put": { + "summary": "Atualiza um campo de cadastro personalizado pelo id", + "description": "", + "operationId": "atualiza-um-campo-de-cadastro-personalizado-pelo-id", + "parameters": [ + { + "name": "camposcadastropersonalizadoId", + "in": "path", + "description": "Id do campo de cadastro personalizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do campo (optional)" + }, + "obrigatorio": { + "type": "boolean", + "description": "Se o campo será obrigatório (optional)" + }, + "ordem": { + "type": "integer", + "description": "Ordem (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec928a8e5b706e1ef93b2" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-conteudo.openapi.json b/wake/utils/openapi/atualiza-um-conteudo.openapi.json new file mode 100644 index 000000000..2d3035e09 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-conteudo.openapi.json @@ -0,0 +1,204 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/conteudos/{conteudoId}": { + "put": { + "summary": "Atualiza um conteúdo", + "description": "", + "operationId": "atualiza-um-conteudo", + "parameters": [ + { + "name": "conteudoId", + "in": "path", + "description": "Identificador do conteúdo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo do conteúdo" + }, + "ativo": { + "type": "boolean", + "description": "Conteúdo ativo/inativo" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do conteúdo (optional)", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de final de exibição do conteúdo (optional)", + "format": "date" + }, + "posicionamento": { + "type": "string", + "description": "Posicionamento do conteúdo", + "enum": [ + "Topo", + "Centro", + "Rodape", + "LateralDireita", + "LateralEsquerda", + "MobileTopo", + "MobileRodape" + ] + }, + "conteudo": { + "type": "string", + "description": "Informações do conteúdo" + }, + "termoBusca": { + "type": "string", + "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" + }, + "exibeTodasBuscas": { + "type": "boolean", + "description": "Exibição do conteúdo nas buscas" + }, + "naoExibeBuscas": { + "type": "boolean", + "description": "Não exibição do conteúdo nas buscas" + }, + "exibeTodosHotsites": { + "type": "boolean", + "description": "Exibição do conteúdo nos hotsites" + }, + "hotsiteId": { + "type": "array", + "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a883279bb3eb0040242a53" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json b/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json new file mode 100644 index 000000000..ea6269109 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-contrato-de-frete.openapi.json @@ -0,0 +1,216 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}": { + "put": { + "summary": "Atualiza um contrato de frete", + "description": "Frete atualizado com sucesso", + "operationId": "atualiza-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do contrato de frete (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Status do contrato de frete (optional)" + }, + "volumeMaximo": { + "type": "integer", + "description": "Volume máximo permitido, em metro cúbico (m³). (optional)", + "format": "int32" + }, + "pesoCubado": { + "type": "number", + "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", + "format": "double" + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "description": "Id da configuração entrega agendada (optional)", + "format": "int32" + }, + "linkRastreamento": { + "type": "string", + "description": "URL rastreamento (optional)" + }, + "ehAssinatura": { + "type": "boolean", + "description": "Contrato é exclusivo assinatura (optional)" + }, + "larguraMaxima": { + "type": "integer", + "description": "Informe a largura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "alturaMaxima": { + "type": "integer", + "description": "Informe a altura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "comprimentoMaximo": { + "type": "integer", + "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", + "format": "int32" + }, + "limiteMaximoDimensoes": { + "type": "integer", + "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", + "format": "int32" + }, + "limitePesoCubado": { + "type": "number", + "description": "Informe o limite de peso cubado, em gramas (g). (optional)", + "format": "double" + }, + "tempoMinimoDespacho": { + "type": "integer", + "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Informe o Id do centro de distribuição (optional)", + "format": "int32" + }, + "valorMinimoProdutos": { + "type": "number", + "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", + "format": "double" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d25cc22ded0014a29a91" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json new file mode 100644 index 000000000..2e445dc7c --- /dev/null +++ b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/enderecos/{enderecoId}": { + "put": { + "summary": "Atualiza um endereço de um usuário pelo e-mail do usuário", + "description": "", + "operationId": "atualiza-um-endereco-de-um-usuario-pelo-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dad5c4affc630065c406fa" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json new file mode 100644 index 000000000..c9a377b9f --- /dev/null +++ b/wake/utils/openapi/atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario.openapi.json @@ -0,0 +1,160 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}/enderecos/{enderecoId}": { + "put": { + "summary": "Atualiza um endereço de um usuário pelo id do usuário", + "description": "", + "operationId": "atualiza-um-endereco-de-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "enderecoId", + "in": "path", + "description": "Id do endereço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dad614c5f1b3008671c8d3" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-evento.openapi.json b/wake/utils/openapi/atualiza-um-evento.openapi.json new file mode 100644 index 000000000..93b6af23b --- /dev/null +++ b/wake/utils/openapi/atualiza-um-evento.openapi.json @@ -0,0 +1,303 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}": { + "put": { + "summary": "Atualiza um evento", + "description": "", + "operationId": "atualiza-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Identificador do tipo de evento", + "format": "int32" + }, + "enderecoEntregaId": { + "type": "integer", + "description": "Identificador do endereço de entrega", + "format": "int32" + }, + "titulo": { + "type": "string", + "description": "Titulo do evento" + }, + "url": { + "type": "string", + "description": "Atributo obsoleto - (optional)" + }, + "data": { + "type": "string", + "description": "Data do Evento", + "format": "date" + }, + "usuarioEmail": { + "type": "string", + "description": "Email do usuário" + }, + "disponivel": { + "type": "boolean", + "description": "Disponibilidade do evento (optional)" + }, + "diasAntesEvento": { + "type": "integer", + "description": "Quantos dias antes do evento ele será exibido (optional)", + "format": "int32" + }, + "diasDepoisEvento": { + "type": "integer", + "description": "Até quantos dias depois do evento ele será exibido (optional)", + "format": "int32" + }, + "urlLogo": { + "type": "string", + "description": "Url do Logo. (Base64)" + }, + "urlCapa": { + "type": "string", + "description": "Url da Capa. (Base64)" + }, + "proprietario": { + "type": "string", + "description": "Quem é o proprietário" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 01 será habilitada" + }, + "textoInfo01": { + "type": "string", + "description": "Texto para o campo informação 01 (optional)" + }, + "conteudoInfo01": { + "type": "string", + "description": "Conteúdo para o campo informação 01 (optional)" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 02 será habilitada" + }, + "textoInfo02": { + "type": "string", + "description": "Texto para o campo informação 02 (optional)" + }, + "conteudoInfo02": { + "type": "string", + "description": "Conteúdo para o campo informação 02 (optional)" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "description": "Se a aba de mensagem será habilitada (optional)" + }, + "enumTipoListaPresenteId": { + "type": "string", + "description": "Tipo de lista de presente", + "enum": [ + "ListaPronta", + "ListaManual" + ] + }, + "enumTipoEntregaId": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "eventoProdutoSelecionado": { + "type": "array", + "description": "Seleção de produto no evento", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se produto recebido fora da lista (optional)" + }, + "removido": { + "type": "boolean", + "description": "Se produto removido (optional)" + } + }, + "type": "object" + } + }, + "enderecoEvento": { + "type": "array", + "description": "Endereço do Evento", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "Nome para identificação do endereço" + }, + "endereco": { + "type": "string", + "description": "Endereço" + }, + "cep": { + "type": "string", + "description": "Cep do endereço" + }, + "numero": { + "type": "string", + "description": "Numero do endereço" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço" + }, + "cidade": { + "type": "string", + "description": "Cidade do endereço" + }, + "estado": { + "type": "string", + "description": "Estado do endereço" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62accac13dbf3400400a146c" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-fabricante.openapi.json b/wake/utils/openapi/atualiza-um-fabricante.openapi.json new file mode 100644 index 000000000..5719957a0 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-fabricante.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes/{fabricanteId}": { + "put": { + "summary": "Atualiza um fabricante", + "description": "", + "operationId": "atualiza-um-fabricante", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do fabricante (optional)" + }, + "urlLogoTipo": { + "type": "string", + "description": "URL tipo logo (optional)" + }, + "urlLink": { + "type": "string", + "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" + }, + "urlCarrossel": { + "type": "string", + "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0886b69241400e931a5b8" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json b/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json new file mode 100644 index 000000000..5771e99d7 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-novo-seller-no-marketplace.openapi.json @@ -0,0 +1,165 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers": { + "put": { + "summary": "Atualiza um novo Seller no marketplace", + "description": "", + "operationId": "atualiza-um-novo-seller-no-marketplace", + "parameters": [ + { + "name": "resellerId", + "in": "query", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "razaoSocial": { + "type": "string", + "description": "Razão Social/Nome do Reseller" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do Seller" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição Estadual do Seller" + }, + "isento": { + "type": "boolean", + "description": "Seller isento de inscrição estadual" + }, + "email": { + "type": "string", + "description": "Email de contato do Seller" + }, + "telefone": { + "type": "string", + "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" + }, + "tipoAutonomia": { + "type": "string", + "description": "Tipo de autonomia do vendedor", + "enum": [ + "ComAutonomia", + "SemAutonomia" + ] + }, + "ativo": { + "type": "boolean", + "description": "Seller Ativo" + }, + "split": { + "type": "boolean", + "description": "Se irá ter Split de frete boolean. Default:false" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," + }, + "cep": { + "type": "string", + "description": "Cep do Seller (utilizado para o calculo de frete)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d5435d9a9b65003e6c2c53" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-parceiro.openapi.json b/wake/utils/openapi/atualiza-um-parceiro.openapi.json new file mode 100644 index 000000000..c6dfcb3f8 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-parceiro.openapi.json @@ -0,0 +1,175 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{parceiroId}": { + "put": { + "summary": "Atualiza um parceiro", + "description": "Parceiro atualizado com sucesso", + "operationId": "atualiza-um-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro" + }, + "tabelaPrecoId": { + "type": "integer", + "description": "Id da tabela de preço (optional)", + "format": "int32" + }, + "portfolioId": { + "type": "integer", + "description": "Id do portfolio (optional)", + "format": "int32" + }, + "tipoEscopo": { + "type": "string", + "description": "Tipo de escopo", + "enum": [ + "Aberto\"", + "Fechado", + "PorCliente" + ] + }, + "ativo": { + "type": "boolean", + "description": "Status do parceiro" + }, + "isMarketPlace": { + "type": "boolean", + "description": "Se o parceiro é marketplace (optional)" + }, + "origem": { + "type": "string", + "description": "Origem (optional)" + }, + "alias": { + "type": "string", + "description": "alias (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "[\n {\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb35b47500e0027269e3b" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-portfolio.openapi.json b/wake/utils/openapi/atualiza-um-portfolio.openapi.json new file mode 100644 index 000000000..c438f4287 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-portfolio.openapi.json @@ -0,0 +1,118 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}": { + "put": { + "summary": "Atualiza um portfolio", + "description": "", + "operationId": "atualiza-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do portfolio" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef25ff3aebb0098964b27" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json b/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json new file mode 100644 index 000000000..b6711fb9f --- /dev/null +++ b/wake/utils/openapi/atualiza-um-produto-em-uma-assinatura.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/produtos/{assinaturaProdutoId}/Alterar": { + "put": { + "summary": "Atualiza um produto em uma assinatura", + "description": "", + "operationId": "atualiza-um-produto-em-uma-assinatura", + "parameters": [ + { + "name": "assinaturaProdutoId", + "in": "path", + "description": "Id do Produto dentro de uma assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "number", + "description": "Novo valor do produto na assinatura (optional)", + "format": "double" + }, + "removido": { + "type": "boolean", + "description": "Se o produto será considerado removido ou não da assinatura (optional)" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto na assinatura (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Produto foi alterado na assinatura": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0b0eeeb452400b2cc1346" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-produto.openapi.json b/wake/utils/openapi/atualiza-um-produto.openapi.json new file mode 100644 index 000000000..5baf9e5c9 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-produto.openapi.json @@ -0,0 +1,395 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}": { + "put": { + "summary": "Atualiza um produto", + "description": "Atualiza um produto com base nos dados enviados", + "operationId": "atualiza-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "idPaiExterno": { + "type": "string", + "description": "Representa o ProdutoId agrupador por variante (optional)" + }, + "idVinculoExterno": { + "type": "string", + "description": "Representa o ParentId agrupador por parent (optional)" + }, + "sku": { + "type": "string", + "description": "(Max Length: 50) Sku do produto" + }, + "nome": { + "type": "string", + "description": "(Max Length: 300) Nome do produto variante" + }, + "nomeProdutoPai": { + "type": "string", + "description": "Nome do produto (pai do variante) (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Tipo de exibição da matriz de atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "contraProposta": { + "type": "boolean", + "description": "Se o produto aceita contra proposta (optional)" + }, + "fabricante": { + "type": "string", + "description": "(Max Length: 100) Nome do fabricante" + }, + "autor": { + "type": "string", + "description": "(Max Length: 500) Nome do autor (optional)" + }, + "editora": { + "type": "string", + "description": "(Max Length: 100) Nome da editora (optional)" + }, + "colecao": { + "type": "string", + "description": "(Max Length: 100) Nome da coleção (optional)" + }, + "genero": { + "type": "string", + "description": "(Max Length: 100) Nome do gênero (optional)" + }, + "precoCusto": { + "type": "number", + "description": "Max Length: 8, \"0000.0000,00\") Preço de custo do produto variante (optional)", + "format": "double" + }, + "precoDe": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço De\" do produto variante (optional)", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") \"Preço Por\" de venda do produto variante", + "format": "double" + }, + "fatorMultiplicadorPreco": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no \"PrecoPor\". (1 por padrão) (optional)", + "format": "double" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega do produto variante (optional)", + "format": "int32" + }, + "valido": { + "type": "boolean", + "description": "Define se um produto variante é valido ou não (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Define se um produto deve ser exibido no site (optional)" + }, + "freteGratis": { + "type": "string", + "description": "Define a qual regra de calculo de frete o produto vai pertencer", + "enum": [ + "Sempre", + "Nunca", + "Neutro", + "Desconsiderar_Regras" + ] + }, + "trocaGratis": { + "type": "boolean", + "description": "Define se o produto variante tem troca grátis (optional)" + }, + "peso": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Peso do produto variante, em gramas (g)", + "format": "double" + }, + "altura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Altura do produto variante, em centímetros (cm).", + "format": "double" + }, + "comprimento": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Comprimento do produto variante, em centímetros (cm).", + "format": "double" + }, + "largura": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") Largura do produto variante, em centímetros (cm).", + "format": "double" + }, + "garantia": { + "type": "integer", + "description": "Define se o produto variante tem garantia (optional)", + "format": "int32" + }, + "isTelevendas": { + "type": "boolean", + "description": "Define se o produto contém televendas (optional)" + }, + "ean": { + "type": "string", + "description": "(Max Length: 25) EAN do produto variante (optional)" + }, + "localizacaoEstoque": { + "type": "string", + "description": "(Max Length: 255) Localização no estoque do produto variante (optional)" + }, + "listaAtacado": { + "type": "array", + "description": "Dados de atacado do produto variante (optional)", + "items": { + "properties": { + "precoPor": { + "type": "number", + "description": "(Max Length: 8, \"0000.0000,00\") - Preco Por do item por atacado", + "format": "double" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade para compra de atacado", + "format": "int32" + } + }, + "type": "object" + } + }, + "estoque": { + "type": "array", + "description": "Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional)", + "items": { + "properties": { + "estoqueFisico": { + "type": "integer", + "description": "Estoque físico do produto", + "format": "int32" + }, + "estoqueReservado": { + "type": "integer", + "description": "Estoque reservado do produto", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição do estoque do produto", + "format": "int32" + }, + "alertaEstoque": { + "type": "integer", + "description": "Quantidade para ativar o alerta de estoque", + "format": "int32" + } + }, + "type": "object" + } + }, + "listaAtributos": { + "type": "array", + "description": "Lista de atributos do produto", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "(Max Length: 100) - Define o nome do atributo" + }, + "valor": { + "type": "string", + "description": "(Max Length: 8, \"0000.0000,00\") - Define o valor do atributo" + }, + "exibir": { + "type": "boolean", + "description": "Define se o atributo deverá ser exibido" + } + }, + "type": "object" + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Quantidade máxima de compra do produto variante (optional)", + "format": "int32" + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "description": "Quantidade mínima de compra do produto variante (optional)", + "format": "int32" + }, + "condicao": { + "type": "string", + "description": "Condição do produto variante (optional)", + "enum": [ + "Novo", + "Usado", + "Renovado", + "Danificado" + ] + }, + "urlVideo": { + "type": "string", + "description": "Url do vídeo do Produto (optional)" + }, + "spot": { + "type": "boolean", + "description": "Se o produto aparece no Spot (optional)" + }, + "paginaProduto": { + "type": "boolean", + "description": "Se o produto aparece na Url (optional)" + }, + "marketplace": { + "type": "boolean", + "description": "Se o produto aparece no Marketplace (optional)" + }, + "somenteParceiros": { + "type": "boolean", + "description": "Se o produto aparece somente nos Parceiros" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deve ser agrupado pelo EAN (optional)" + }, + "prazoValidade": { + "type": "integer", + "description": "Prazo de validade ou consumo do produto (optional)", + "format": "int32" + }, + "consumo": { + "type": "object", + "description": "Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional)", + "properties": { + "quantidadeDias": { + "type": "integer", + "description": "Quantidade de Dias (optional)", + "format": "int32" + }, + "enviarEmail": { + "type": "boolean", + "description": "Enviar e-mail (optional)" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c32ea54e560b0014096ac6" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-script-existente.openapi.json b/wake/utils/openapi/atualiza-um-script-existente.openapi.json new file mode 100644 index 000000000..98c9acd67 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-script-existente.openapi.json @@ -0,0 +1,206 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts/{scriptId}": { + "put": { + "summary": "Atualiza um script existente", + "description": "", + "operationId": "atualiza-um-script-existente", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do script" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do script", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do script", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Informe se o script está ativo ou não" + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do script", + "format": "int32" + }, + "posicao": { + "type": "string", + "description": "Posição do script", + "enum": [ + "HeaderPrimeiraLinha", + "HeaderUltimaLinha", + "BodyPrimeiraLinha", + "BodyUltimaLinha", + "FooterPrimeiraLinha", + "FooterUltimeLinha" + ] + }, + "tipoPagina": { + "type": "string", + "description": "Tipo da página do script", + "enum": [ + "Todas", + "Home", + "Busca", + "Categoria", + "Fabricante", + "Estaticas", + "Produto", + "Carrinho" + ] + }, + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b465f3b2e610001aca35e7" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json new file mode 100644 index 000000000..113a90c54 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-seo-de-um-produto-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo": { + "put": { + "summary": "Atualiza um SEO de um produto específico", + "description": "", + "operationId": "atualiza-um-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" + }, + "title": { + "type": "string", + "description": "Informe o title da página do produto (optional)" + }, + "metaTags": { + "type": "array", + "description": "Informe os dados da Meta Tag (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c881000f98d4006a920d78" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json b/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json new file mode 100644 index 000000000..98c517753 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-usuario-pelo-email.openapi.json @@ -0,0 +1,239 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}": { + "put": { + "summary": "Atualiza um usuário pelo email", + "description": "", + "operationId": "atualiza-um-usuario-pelo-email", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d99364cec32f0013e7bdae" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json new file mode 100644 index 000000000..8744131a0 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-usuario-pelo-id.openapi.json @@ -0,0 +1,240 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}": { + "put": { + "summary": "Atualiza um usuário pelo id", + "description": "", + "operationId": "atualiza-um-usuario-pelo-id", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d99116940b47009ad96278" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json b/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json new file mode 100644 index 000000000..4b02f545e --- /dev/null +++ b/wake/utils/openapi/atualiza-um-valor-pre-definido-pelo-id.openapi.json @@ -0,0 +1,123 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/valoresdefinidoscadastropersonalizado/{valoresDefinidosCampoGrupoInformacaoId}": { + "put": { + "summary": "Atualiza um valor pré definido pelo id", + "description": "", + "operationId": "atualiza-um-valor-pre-definido-pelo-id", + "parameters": [ + { + "name": "valoresDefinidosCampoGrupoInformacaoId", + "in": "path", + "description": "Id dos valores definidos no campo grupo informação", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "string", + "description": "Valor para o campo (optional)" + }, + "ordem": { + "type": "integer", + "description": "Ordem (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62deca4f112bba03863d34ee" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json new file mode 100644 index 000000000..c262b36d6 --- /dev/null +++ b/wake/utils/openapi/atualiza-um-vinculo-entre-usuario-e-parceiro.openapi.json @@ -0,0 +1,127 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/parceiro": { + "put": { + "summary": "Atualiza um vínculo entre usuário e parceiro", + "description": "", + "operationId": "atualiza-um-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário que se deseja vincular", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "vinculoVitalicio": { + "type": "boolean", + "description": "Vinculo vitalício (optional)" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do vinculo entre usuário e parceiro (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do vinculo entre usuário e parceiro (optional)", + "format": "date" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de924dd176ec0022200a56" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json new file mode 100644 index 000000000..1b8df2310 --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json @@ -0,0 +1,189 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/erp/{id}": { + "put": { + "summary": "Atualiza uma categoria utilizando o id do erp como identificador", + "description": "", + "operationId": "atualiza-uma-categoria-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa0e377ed8eb0094e81562" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-categoria.openapi.json b/wake/utils/openapi/atualiza-uma-categoria.openapi.json new file mode 100644 index 000000000..c12ab6572 --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-categoria.openapi.json @@ -0,0 +1,189 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/{id}": { + "put": { + "summary": "Atualiza uma categoria", + "description": "", + "operationId": "atualiza-uma-categoria", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa06a9f42f94009b1ccb1f" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json b/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json new file mode 100644 index 000000000..7c5edaf60 --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-informacao-de-um-produto.openapi.json @@ -0,0 +1,183 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/informacoes/{informacaoId}": { + "put": { + "summary": "Atualiza uma informação de um produto", + "description": "Atualiza uma informação de um produto específico", + "operationId": "atualiza-uma-informacao-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "informacaoId", + "in": "path", + "description": "Id da informação do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo da informação (optional)" + }, + "texto": { + "type": "string", + "description": "Texto da informação (optional)" + }, + "exibirSite": { + "type": "boolean", + "description": "Informação se o produto variante está visível no site." + }, + "tipoInformacao": { + "type": "string", + "description": "Tipo de informação do produto (optional)", + "enum": [ + "Informacoes", + "Beneficios", + "Especificacoes", + "DadosTecnicos", + "Composicao", + "ModoDeUsar", + "Cuidados", + "ItensInclusos", + "Dicas", + "Video", + "Descricao", + "ValorReferente", + "PopUpReferente", + "Prescricao", + "TabelaDeMedidas", + "Spot", + "Sinopse", + "Carrinho" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c44a6b08078700343baccb" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-inscricao.openapi.json b/wake/utils/openapi/atualiza-uma-inscricao.openapi.json new file mode 100644 index 000000000..40d49d4c4 --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-inscricao.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/inscricao/{inscricaoId}": { + "put": { + "summary": "Atualiza uma inscrição", + "description": "", + "operationId": "atualiza-uma-inscricao", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "topicos" + ], + "properties": { + "nome": { + "type": "string", + "description": "Nome da inscrição" + }, + "appUrl": { + "type": "string", + "description": "Url para qual deve ser enviada as notificações" + }, + "topicos": { + "type": "array", + "description": "Tópicos em que deseja se inscrever", + "items": { + "type": "string" + } + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a inscrição" + }, + "ativo": { + "type": "boolean", + "description": "Status da inscrição, se ativada ou desativada" + }, + "emailResponsavel": { + "type": "string", + "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" + }, + "headers": { + "type": "array", + "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave do header, por exemplo: 'Authorization'" + }, + "valor": { + "type": "string", + "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bc5f8f5f7d60003f1d1ca5" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..8da8cc3e7 --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json @@ -0,0 +1,187 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}/produtos": { + "put": { + "summary": "Atualiza uma lista de produto variantes em uma tabela de preços", + "description": "Lista com o retorno do processamento dos produtos enviados", + "operationId": "atualiza-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de produtos variantes", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "SKU do produto" + }, + "precoDe": { + "type": "number", + "description": "Preço De do produto", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "Preço Por do produto", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sucesso": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "erro": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6ab3a3877de0080895f3f" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json b/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json new file mode 100644 index 000000000..3f3d0610e --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-loja-fisica.openapi.json @@ -0,0 +1,251 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}": { + "put": { + "summary": "Atualiza uma Loja Física", + "description": "", + "operationId": "atualiza-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "description": "Id da loja (optional)", + "format": "int32" + }, + "nome": { + "type": "string", + "description": "Nome da loja (optional)" + }, + "ddd": { + "type": "integer", + "description": "DDD da localidade de destino da loja (optional)", + "format": "int32" + }, + "telefone": { + "type": "string", + "description": "Telefone da loja (optional)" + }, + "email": { + "type": "string", + "description": "E-mail de contato da loja (optional)" + }, + "cep": { + "type": "string", + "description": "CEP do endereço da loja (optional)" + }, + "logradouro": { + "type": "string", + "description": "Logradouro do endereço da loja (optional)" + }, + "numero": { + "type": "string", + "description": "Número de localização do endereço da loja (optional)" + }, + "complemento": { + "type": "string", + "description": "Complemento para localização da loja (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço do loja (optional)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que a loja se encontra (optional)" + }, + "estadoId": { + "type": "integer", + "description": "Id do estado em que a loja se encontra (optional)", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega (optional)", + "format": "int32" + }, + "prazoMaximoRetirada": { + "type": "integer", + "description": "Prazo máximo para retirada (optional)", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Status da loja (optional)" + }, + "valido": { + "type": "boolean", + "description": "Valido (optional)" + }, + "textoComplementar": { + "type": "string", + "description": "Informações complementares da loja (optional)" + }, + "retirarNaLoja": { + "type": "boolean", + "description": "Se a retirada na loja será ativada (optional)" + }, + "latitude": { + "type": "number", + "description": "Latitude (optional)", + "format": "double" + }, + "longitude": { + "type": "number", + "description": "Longitude (optional)", + "format": "double" + }, + "centroDistribuicao": { + "type": "array", + "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b9b5c006c3f8008caaa98e" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..87aed88dd --- /dev/null +++ b/wake/utils/openapi/atualiza-uma-tabela-de-precos.openapi.json @@ -0,0 +1,132 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}": { + "put": { + "summary": "Atualiza uma tabela de preços", + "description": "", + "operationId": "atualiza-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da tabela de preço" + }, + "dataInicial": { + "type": "string", + "description": "Data que inicia a tabela de preço", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data de término da tabela de preço", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Status da tabela de preço" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a90380c565001fa1e489" +} \ No newline at end of file diff --git a/wake/utils/openapi/atualizar-autor.openapi.json b/wake/utils/openapi/atualizar-autor.openapi.json new file mode 100644 index 000000000..cde37f660 --- /dev/null +++ b/wake/utils/openapi/atualizar-autor.openapi.json @@ -0,0 +1,153 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores/{autorId}": { + "put": { + "summary": "Atualizar autor", + "description": "", + "operationId": "atualizar-autor", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Autor" + }, + "ativo": { + "type": "boolean", + "description": "Status do autor" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a1dace443345001ac941c1" +} \ No newline at end of file diff --git a/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json b/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json new file mode 100644 index 000000000..ad2b7ce5b --- /dev/null +++ b/wake/utils/openapi/bloqueia-ou-desbloqueia-usuarios.openapi.json @@ -0,0 +1,138 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/bloquear": { + "put": { + "summary": "Bloqueia ou desbloqueia usuários", + "description": "Campo atualizado com sucesso", + "operationId": "bloqueia-ou-desbloqueia-usuarios", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Usuários (optional)", + "items": { + "properties": { + "email": { + "type": "string", + "description": "E-mail do usuário" + }, + "bloqueado": { + "type": "boolean", + "description": "Status do usuário" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"usuariosAtualizados\": [\n \"string\"\n ],\n \"usuariosNaoAtualizados\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuariosAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuariosNaoAtualizados": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62deccc387bd9a0027ff964f" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json b/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json new file mode 100644 index 000000000..b96b8411b --- /dev/null +++ b/wake/utils/openapi/busca-a-inscricao-por-seu-identificador.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/inscricao/{inscricaoId}": { + "get": { + "summary": "Busca a inscrição por seu identificador", + "description": "Inscrição", + "operationId": "busca-a-inscricao-por-seu-identificador", + "parameters": [ + { + "name": "inscricaoId", + "in": "path", + "description": "Id da inscrição", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "inscricaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "appUrl": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "emailResponsavel": { + "type": "string", + "example": "string" + }, + "topico": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuario": { + "type": "string", + "example": "string" + }, + "header": { + "type": "array", + "items": { + "type": "object", + "properties": { + "headerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb5238fd766d00203ed45f" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json b/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json new file mode 100644 index 000000000..f5a5747d8 --- /dev/null +++ b/wake/utils/openapi/busca-o-conteudo-de-uma-versao.openapi.json @@ -0,0 +1,166 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts/{scriptId}/versao/{versaoId}/conteudo": { + "get": { + "summary": "Busca o conteúdo de uma versão", + "description": "Lista o conteúdo de uma versão", + "operationId": "busca-o-conteudo-de-uma-versao", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "versaoId", + "in": "path", + "description": "Id da versão", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"scriptId\": 0,\n \"versaoId\": 0,\n \"conteudo\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "versaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "conteudo": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b4672b44ceb9007b673297" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json b/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json new file mode 100644 index 000000000..3f1001f08 --- /dev/null +++ b/wake/utils/openapi/busca-o-conteudo-pelo-seu-id.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/conteudos/{conteudoId}": { + "get": { + "summary": "Busca o conteúdo pelo seu id", + "description": "Conteúdo encontrado", + "operationId": "busca-o-conteudo-pelo-seu-id", + "parameters": [ + { + "name": "conteudoId", + "in": "path", + "description": "Identificador do conteúdo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a882bceeff6c0303ab0d80" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json new file mode 100644 index 000000000..7c96f163c --- /dev/null +++ b/wake/utils/openapi/busca-o-seo-de-um-produto-especifico.openapi.json @@ -0,0 +1,157 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo": { + "get": { + "summary": "Busca o SEO de um produto específico", + "description": "SEO do produto informado", + "operationId": "busca-o-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tagCanonical\": \"string\",\n \"title\": \"string\",\n \"metatags\": [\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "example": "string" + }, + "title": { + "type": "string", + "example": "string" + }, + "metatags": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c49ae47aa2fa00aadf0d41" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..8c5762013 --- /dev/null +++ b/wake/utils/openapi/busca-os-banners-vinculados-a-um-hotsite-especifico.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/banners": { + "get": { + "summary": "Busca os banners vinculados a um hotsite específico", + "description": "Lista de identificadores de banners vinculados ao hotsite", + "operationId": "busca-os-banners-vinculados-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"bannerId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a89d61050cb2044569d479" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..749cc7492 --- /dev/null +++ b/wake/utils/openapi/busca-os-conteudos-vinculados-a-um-hotsite-especifico.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/conteudos": { + "get": { + "summary": "Busca os conteúdos vinculados a um hotsite específico", + "description": "Lista de identificadores de conteúdos vinculados ao hotsite", + "operationId": "busca-os-conteudos-vinculados-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscados os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"conteudoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a8e59fcc1f8e003c4203a5" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-estados.openapi.json b/wake/utils/openapi/busca-os-estados.openapi.json new file mode 100644 index 000000000..689c737fc --- /dev/null +++ b/wake/utils/openapi/busca-os-estados.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/estados": { + "get": { + "summary": "Busca os estados", + "description": "Lista dos estados", + "operationId": "busca-os-estados", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"estadoId\": 0,\n \"nome\": \"string\",\n \"sigla\": \"string\",\n \"regiao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "sigla": { + "type": "string", + "example": "string" + }, + "regiao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b9baa85f463904e9443138" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json b/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json new file mode 100644 index 000000000..a32aa31cb --- /dev/null +++ b/wake/utils/openapi/busca-os-hotsites-vinculados-de-um-banner-especifico.openapi.json @@ -0,0 +1,157 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/hotsites": { + "get": { + "summary": "Busca os hotsites vinculados de um banner específico", + "description": "Lista de hotsites vinculados ao banner", + "operationId": "busca-os-hotsites-vinculados-de-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve buscar os hotsites vinculados.", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7485c784ec80041ceb41e" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json b/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json new file mode 100644 index 000000000..56149fe17 --- /dev/null +++ b/wake/utils/openapi/busca-os-metatags-de-um-produto-especifico.openapi.json @@ -0,0 +1,144 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo/metaTag": { + "get": { + "summary": "Busca os metatags de um produto específico", + "description": "Lista de Metatags do produto informado", + "operationId": "busca-os-metatags-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c5781eaec04f0084b9fb43" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json b/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json new file mode 100644 index 000000000..b70790fe9 --- /dev/null +++ b/wake/utils/openapi/busca-os-parceiros-vinculados-de-um-banner-especifico.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/parceiros": { + "get": { + "summary": "Busca os parceiros vinculados de um banner específico", + "description": "Lista de parceiros vinculados ao banner", + "operationId": "busca-os-parceiros-vinculados-de-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve buscar os parceiros vinculados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7729a44dd7e03c9874a9a" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json b/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json new file mode 100644 index 000000000..889097d1d --- /dev/null +++ b/wake/utils/openapi/busca-os-possiveis-posicionamentos-para-o-banner.openapi.json @@ -0,0 +1,139 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/posicionamentos": { + "get": { + "summary": "Busca os possíveis posicionamentos para o banner", + "description": "Lista de posicionamentos do banner", + "operationId": "busca-os-possiveis-posicionamentos-para-o-banner", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"posicionamentoId\": 0,\n \"descricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a775da9c36f70050eafda8" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json b/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json new file mode 100644 index 000000000..fc77da5e1 --- /dev/null +++ b/wake/utils/openapi/busca-os-produtos-relacionados.openapi.json @@ -0,0 +1,154 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/relacionados": { + "get": { + "summary": "Busca os produtos relacionados", + "description": "Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado", + "operationId": "busca-os-produtos-relacionados", + "parameters": [ + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + }, + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"parentId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "parentId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c32f9aaa3da40421de580b" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json b/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json new file mode 100644 index 000000000..0162ad0a8 --- /dev/null +++ b/wake/utils/openapi/busca-os-produtos-sugeridos-para-a-lista-de-evento.openapi.json @@ -0,0 +1,121 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}/produtos": { + "get": { + "summary": "Busca os produtos sugeridos para a lista de evento", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "busca-os-produtos-sugeridos-para-a-lista-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tipoEventoId\": 0,\n \"produtoVariantePrincipalId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVariantePrincipalId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ceb2333a7de2026c4611e4" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json b/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json new file mode 100644 index 000000000..d53d02ba0 --- /dev/null +++ b/wake/utils/openapi/busca-os-topicos-disponiveis-para-inscricao.openapi.json @@ -0,0 +1,111 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/Topicos": { + "get": { + "summary": "Busca os tópicos disponíveis para inscrição", + "description": "Lista de Tópicos", + "operationId": "busca-os-topicos-disponiveis-para-inscricao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"payload\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + }, + "payload": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb6481fa3fdf003be8bed4" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json b/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json new file mode 100644 index 000000000..ca6d2180a --- /dev/null +++ b/wake/utils/openapi/busca-pedidos-que-ainda-nao-foram-setado-o-complete.openapi.json @@ -0,0 +1,135 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/naoIntegrados": { + "get": { + "summary": "Busca pedidos que ainda não foram setado o complete", + "description": "Lista de números de pedidos ainda não integrados", + "operationId": "busca-pedidos-que-ainda-nao-foram-setado-o-complete", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb3896237430004df21cf0" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json b/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json new file mode 100644 index 000000000..2b509d8ba --- /dev/null +++ b/wake/utils/openapi/busca-produtos-vinculados-a-um-evento.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}/produtos": { + "get": { + "summary": "Busca produtos vinculados a um evento", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "busca-produtos-vinculados-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac88ce1ccd8700422c2db2" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json b/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json new file mode 100644 index 000000000..23507fa7b --- /dev/null +++ b/wake/utils/openapi/busca-todas-as-inscricoes-inseridas.openapi.json @@ -0,0 +1,153 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/inscricao": { + "get": { + "summary": "Busca todas as inscrições inseridas", + "description": "Lista de inscrições", + "operationId": "busca-todas-as-inscricoes-inseridas", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"inscricaoId\": 0,\n \"nome\": \"string\",\n \"appUrl\": \"string\",\n \"ativo\": true,\n \"emailResponsavel\": \"string\",\n \"topico\": [\n \"string\"\n ],\n \"usuario\": \"string\",\n \"header\": [\n {\n \"headerId\": 0,\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "inscricaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "appUrl": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "emailResponsavel": { + "type": "string", + "example": "string" + }, + "topico": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "usuario": { + "type": "string", + "example": "string" + }, + "header": { + "type": "array", + "items": { + "type": "object", + "properties": { + "headerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a34bf489dc890013d79075" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json b/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json new file mode 100644 index 000000000..8b1200f09 --- /dev/null +++ b/wake/utils/openapi/busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario.openapi.json @@ -0,0 +1,185 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/contascorrentes/{email}/extrato": { + "get": { + "summary": "Busca todas as movimentações de conta corrente de um usuário", + "description": "Extrato retornado com sucesso", + "operationId": "busca-todas-as-movimentacoes-de-conta-corrente-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data Inicial para verificar extrato", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data Final para verificar extrato", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"data\": \"2022-06-15T13:26:37.748Z\",\n \"historico\": \"string\",\n \"valor\": 0,\n \"tipoLancamento\": \"Credito\",\n \"observacao\": \"string\",\n \"visivelParaCliente\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-15T13:26:37.748Z" + }, + "historico": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoLancamento": { + "type": "string", + "example": "Credito" + }, + "observacao": { + "type": "string", + "example": "string" + }, + "visivelParaCliente": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa2dba0522f500488ccbd1" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json b/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json new file mode 100644 index 000000000..f2cbcb4d8 --- /dev/null +++ b/wake/utils/openapi/busca-todas-as-versoes-de-um-script.openapi.json @@ -0,0 +1,169 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts/{scriptId}/versoes": { + "get": { + "summary": "Busca todas as versões de um script", + "description": "Lista de versões", + "operationId": "busca-todas-as-versoes-de-um-script", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"versaoId\": 0,\n \"scriptId\": 0,\n \"dataCadastro\": \"2022-06-23T11:17:57.658Z\",\n \"identificadorPagina\": \"string\",\n \"publicado\": true,\n \"usuario\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "versaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataCadastro": { + "type": "string", + "example": "2022-06-23T11:17:57.658Z" + }, + "identificadorPagina": { + "type": "string", + "example": "string" + }, + "publicado": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b46847f1a5f5006cf745bc" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-banners.openapi.json b/wake/utils/openapi/busca-todos-banners.openapi.json new file mode 100644 index 000000000..aa2c1fb08 --- /dev/null +++ b/wake/utils/openapi/busca-todos-banners.openapi.json @@ -0,0 +1,363 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners": { + "get": { + "summary": "Busca todos banners", + "description": "Lista de banners", + "operationId": "busca-todos-banners", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-13T11:13:55.299Z\",\n \"dataFim\": \"2022-06-13T11:13:55.299Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-13T11:13:55.299Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-13T11:13:55.299Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhe": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlBanner": { + "type": "string", + "example": "string" + }, + "imagemBanner": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "base64": { + "type": "string", + "example": "string" + }, + "formato": { + "type": "string", + "example": "PNG" + } + } + }, + "ordemExibicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "abrirBannerNovaAba": { + "type": "boolean", + "example": true, + "default": true + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "title": { + "type": "string", + "example": "string" + }, + "urlClique": { + "type": "string", + "example": "string" + }, + "urlBannerAlternativo": { + "type": "string", + "example": "string" + }, + "titleAlternativo": { + "type": "string", + "example": "string" + }, + "diasExibicao": { + "type": "object", + "properties": { + "todosDias": { + "type": "boolean", + "example": true, + "default": true + }, + "domingo": { + "type": "boolean", + "example": true, + "default": true + }, + "segunda": { + "type": "boolean", + "example": true, + "default": true + }, + "terca": { + "type": "boolean", + "example": true, + "default": true + }, + "quarta": { + "type": "boolean", + "example": true, + "default": true + }, + "quinta": { + "type": "boolean", + "example": true, + "default": true + }, + "sexta": { + "type": "boolean", + "example": true, + "default": true + }, + "sabado": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "textoAlternativo": { + "type": "string", + "example": "string" + } + } + }, + "apresentacao": { + "type": "object", + "properties": { + "exibirNoSite": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibirEmBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "termosBusca": { + "type": "string", + "example": "string" + }, + "listaHotsites": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "example": true, + "default": true + }, + "listaParceiros": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "parceiros": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a73b9f57855a01175e0f3e" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-conteudos.openapi.json b/wake/utils/openapi/busca-todos-os-conteudos.openapi.json new file mode 100644 index 000000000..89cfec522 --- /dev/null +++ b/wake/utils/openapi/busca-todos-os-conteudos.openapi.json @@ -0,0 +1,192 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/conteudos": { + "get": { + "summary": "Busca todos os conteúdos", + "description": "Conteúdos encontrados", + "operationId": "busca-todos-os-conteudos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"conteudoId\": 0,\n \"titulo\": \"string\",\n \"ativo\": true,\n \"dataInicio\": \"2022-06-13T11:13:55.432Z\",\n \"dataFim\": \"2022-06-13T11:13:55.432Z\",\n \"posicionamento\": \"Topo\",\n \"codigoFonte\": \"string\",\n \"termoBusca\": \"string\",\n \"exibeTodasBuscas\": true,\n \"naoExibeBuscas\": true,\n \"exibeTodosHotsites\": true,\n \"hotsitesId\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicio": { + "type": "string", + "example": "2022-06-13T11:13:55.432Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-13T11:13:55.432Z" + }, + "posicionamento": { + "type": "string", + "example": "Topo" + }, + "codigoFonte": { + "type": "string", + "example": "string" + }, + "termoBusca": { + "type": "string", + "example": "string" + }, + "exibeTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibeBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "exibeTodosHotsites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotsitesId": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a795f0a9696c00b6665d44" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json b/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json new file mode 100644 index 000000000..1eef28022 --- /dev/null +++ b/wake/utils/openapi/busca-todos-os-hotsites-inseridos.openapi.json @@ -0,0 +1,279 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites": { + "get": { + "summary": "Busca todos os hotsites inseridos", + "description": "Lista de hotsites", + "operationId": "busca-todos-os-hotsites-inseridos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadePorPagina", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.198Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.198Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.198Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "template": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-14T11:07:54.198Z" + }, + "url": { + "type": "string", + "example": "string" + }, + "tamanhoPagina": { + "type": "integer", + "example": 0, + "default": 0 + }, + "templateId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordenacao": { + "type": "string", + "example": "Nenhuma" + }, + "listaProdutos": { + "type": "object", + "properties": { + "expressao": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "seo": { + "type": "object", + "properties": { + "seoHotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "metas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "banners": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "conteudos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a886f80a083f009b233919" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json b/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json new file mode 100644 index 000000000..39469b406 --- /dev/null +++ b/wake/utils/openapi/busca-todos-os-scripts-inseridos.openapi.json @@ -0,0 +1,165 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts": { + "get": { + "summary": "Busca todos os scripts inseridos", + "description": "Lista de scripts", + "operationId": "busca-todos-os-scripts-inseridos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"scriptId\": 0,\n \"nome\": \"string\",\n \"posicao\": \"HeaderPrimeiraLinha\",\n \"tipoPagina\": \"Todas\",\n \"dataInicial\": \"2022-06-23T11:17:57.626Z\",\n \"datafinal\": \"2022-06-23T11:17:57.626Z\",\n \"ativo\": true,\n \"prioridade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "scriptId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "posicao": { + "type": "string", + "example": "HeaderPrimeiraLinha" + }, + "tipoPagina": { + "type": "string", + "example": "Todas" + }, + "dataInicial": { + "type": "string", + "example": "2022-06-23T11:17:57.626Z" + }, + "datafinal": { + "type": "string", + "example": "2022-06-23T11:17:57.626Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b1cd784fb14d006f388284" +} \ No newline at end of file diff --git a/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json b/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..689d0cc64 --- /dev/null +++ b/wake/utils/openapi/busca-um-hotsite-especifico.openapi.json @@ -0,0 +1,283 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}": { + "get": { + "summary": "Busca um hotsite específico", + "description": "Objeto do hotsite", + "operationId": "busca-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser buscado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"hotsiteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"template\": \"string\",\n \"dataCriacao\": \"2022-06-14T11:07:54.213Z\",\n \"dataInicio\": \"2022-06-14T11:07:54.213Z\",\n \"dataFinal\": \"2022-06-14T11:07:54.213Z\",\n \"url\": \"string\",\n \"tamanhoPagina\": 0,\n \"templateId\": 0,\n \"ordenacao\": \"Nenhuma\",\n \"listaProdutos\": {\n \"expressao\": \"string\",\n \"produtos\": [\n {\n \"produtoId\": 0,\n \"ordem\": 0\n }\n ]\n },\n \"seo\": {\n \"seoHotsiteId\": 0,\n \"hotsiteId\": 0,\n \"titulo\": \"string\",\n \"metas\": [\n {\n \"conteudo\": \"string\",\n \"nome\": \"string\",\n \"httpEquiv\": \"string\",\n \"scheme\": \"string\"\n }\n ]\n },\n \"banners\": [\n {\n \"bannerId\": 0\n }\n ],\n \"conteudos\": [\n {\n \"conteudoId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "template": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-14T11:07:54.213Z" + }, + "url": { + "type": "string", + "example": "string" + }, + "tamanhoPagina": { + "type": "integer", + "example": 0, + "default": 0 + }, + "templateId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordenacao": { + "type": "string", + "example": "Nenhuma" + }, + "listaProdutos": { + "type": "object", + "properties": { + "expressao": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "seo": { + "type": "object", + "properties": { + "seoHotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "hotsiteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "metas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "banners": { + "type": "array", + "items": { + "type": "object", + "properties": { + "bannerId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "conteudos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "conteudoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a899e59f542f002f2f9894" +} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json b/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json new file mode 100644 index 000000000..0fe1dd623 --- /dev/null +++ b/wake/utils/openapi/buscar-autor-pelo-nome.openapi.json @@ -0,0 +1,133 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores/{nomeAutor}": { + "get": { + "summary": "Buscar autor pelo nome", + "description": "", + "operationId": "buscar-autor-pelo-nome", + "parameters": [ + { + "name": "nomeAutor", + "in": "path", + "description": "Nome do autor", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a1dc027abf93008b11f4a2" +} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-autor-por-id.openapi.json b/wake/utils/openapi/buscar-autor-por-id.openapi.json new file mode 100644 index 000000000..e9c044921 --- /dev/null +++ b/wake/utils/openapi/buscar-autor-por-id.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores/{autorId}": { + "get": { + "summary": "Buscar autor por id", + "description": "", + "operationId": "buscar-autor-por-id", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a1da72e40b2500337971fc" +} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-banner-por-id.openapi.json b/wake/utils/openapi/buscar-banner-por-id.openapi.json new file mode 100644 index 000000000..b8ae9ca47 --- /dev/null +++ b/wake/utils/openapi/buscar-banner-por-id.openapi.json @@ -0,0 +1,337 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}": { + "get": { + "summary": "Buscar banner por Id", + "description": "Objeto do banner", + "operationId": "buscar-banner-por-id", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve ser buscado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"dataInicio\": \"2022-06-10T13:20:59.150Z\",\n \"dataFim\": \"2022-06-10T13:20:59.150Z\",\n \"ativo\": true,\n \"detalhe\": {\n \"posicionamentoId\": 0,\n \"urlBanner\": \"string\",\n \"imagemBanner\": {\n \"nome\": \"string\",\n \"base64\": \"string\",\n \"formato\": \"PNG\"\n },\n \"ordemExibicao\": 0,\n \"abrirBannerNovaAba\": true,\n \"largura\": 0,\n \"altura\": 0,\n \"title\": \"string\",\n \"urlClique\": \"string\",\n \"urlBannerAlternativo\": \"string\",\n \"titleAlternativo\": \"string\",\n \"diasExibicao\": {\n \"todosDias\": true,\n \"domingo\": true,\n \"segunda\": true,\n \"terca\": true,\n \"quarta\": true,\n \"quinta\": true,\n \"sexta\": true,\n \"sabado\": true\n },\n \"textoAlternativo\": \"string\"\n },\n \"apresentacao\": {\n \"exibirNoSite\": true,\n \"exibirEmTodasBuscas\": true,\n \"naoExibirEmBuscas\": true,\n \"termosBusca\": \"string\",\n \"listaHotsites\": {\n \"exibirEmTodosHotSites\": true,\n \"hotSites\": [\n {\n \"hotSiteId\": 0\n }\n ]\n },\n \"exibirEmTodasCategorias\": true,\n \"listaParceiros\": {\n \"exibirEmTodosParceiros\": true,\n \"parceiros\": [\n {\n \"parceiroId\": 0\n }\n ]\n }\n }\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicio": { + "type": "string", + "example": "2022-06-10T13:20:59.150Z" + }, + "dataFim": { + "type": "string", + "example": "2022-06-10T13:20:59.150Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhe": { + "type": "object", + "properties": { + "posicionamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlBanner": { + "type": "string", + "example": "string" + }, + "imagemBanner": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "base64": { + "type": "string", + "example": "string" + }, + "formato": { + "type": "string", + "example": "PNG" + } + } + }, + "ordemExibicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "abrirBannerNovaAba": { + "type": "boolean", + "example": true, + "default": true + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "title": { + "type": "string", + "example": "string" + }, + "urlClique": { + "type": "string", + "example": "string" + }, + "urlBannerAlternativo": { + "type": "string", + "example": "string" + }, + "titleAlternativo": { + "type": "string", + "example": "string" + }, + "diasExibicao": { + "type": "object", + "properties": { + "todosDias": { + "type": "boolean", + "example": true, + "default": true + }, + "domingo": { + "type": "boolean", + "example": true, + "default": true + }, + "segunda": { + "type": "boolean", + "example": true, + "default": true + }, + "terca": { + "type": "boolean", + "example": true, + "default": true + }, + "quarta": { + "type": "boolean", + "example": true, + "default": true + }, + "quinta": { + "type": "boolean", + "example": true, + "default": true + }, + "sexta": { + "type": "boolean", + "example": true, + "default": true + }, + "sabado": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "textoAlternativo": { + "type": "string", + "example": "string" + } + } + }, + "apresentacao": { + "type": "object", + "properties": { + "exibirNoSite": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "naoExibirEmBuscas": { + "type": "boolean", + "example": true, + "default": true + }, + "termosBusca": { + "type": "string", + "example": "string" + }, + "listaHotsites": { + "type": "object", + "properties": { + "exibirEmTodosHotSites": { + "type": "boolean", + "example": true, + "default": true + }, + "hotSites": { + "type": "array", + "items": { + "type": "object", + "properties": { + "hotSiteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "example": true, + "default": true + }, + "listaParceiros": { + "type": "object", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "parceiros": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a35336a70b19004482f095" +} \ No newline at end of file diff --git a/wake/utils/openapi/buscar-todos-os-autores.openapi.json b/wake/utils/openapi/buscar-todos-os-autores.openapi.json new file mode 100644 index 000000000..32d1efa80 --- /dev/null +++ b/wake/utils/openapi/buscar-todos-os-autores.openapi.json @@ -0,0 +1,84 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores": { + "get": { + "summary": "Buscar todos os autores", + "description": "", + "operationId": "buscar-todos-os-autores", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0fd79f0f787009eb49416" +} \ No newline at end of file diff --git a/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json b/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json new file mode 100644 index 000000000..038668bec --- /dev/null +++ b/wake/utils/openapi/cria-assinatura-com-base-em-uma-lista-de-pedidos.openapi.json @@ -0,0 +1,138 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/grupoassinatura/assinatura": { + "post": { + "summary": "Cria assinatura com base em uma lista de pedidos", + "description": "Pedidos que terão vínculo com o grupo de assinatura informado.", + "operationId": "cria-assinatura-com-base-em-uma-lista-de-pedidos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pedidos": { + "type": "array", + "description": "Lista de pedidos a serem vinculados a assinatura", + "items": { + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido", + "format": "int32" + } + }, + "type": "object" + } + }, + "recorrenciaId": { + "type": "integer", + "description": "ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura", + "format": "int32" + }, + "grupoAssinaturaId": { + "type": "integer", + "description": "ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "text/plain": { + "examples": { + "Erro no processamento da operação": { + "value": "" + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:63adc9f79b51fc00122338f6" +} \ No newline at end of file diff --git a/wake/utils/openapi/cria-um-novo-evento.openapi.json b/wake/utils/openapi/cria-um-novo-evento.openapi.json new file mode 100644 index 000000000..bbc5b3d16 --- /dev/null +++ b/wake/utils/openapi/cria-um-novo-evento.openapi.json @@ -0,0 +1,291 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos": { + "post": { + "summary": "Cria um Novo Evento", + "description": "", + "operationId": "cria-um-novo-evento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Identificador do tipo de evento", + "format": "int32" + }, + "enderecoEntregaId": { + "type": "integer", + "description": "Identificador do endereço de entrega", + "format": "int32" + }, + "titulo": { + "type": "string", + "description": "Titulo do evento" + }, + "url": { + "type": "string", + "description": "URL do evento" + }, + "data": { + "type": "string", + "description": "Data do Evento", + "format": "date" + }, + "usuarioEmail": { + "type": "string", + "description": "Email do usuário" + }, + "disponivel": { + "type": "boolean", + "description": "Disponibilidade do evento (optional)" + }, + "diasAntesEvento": { + "type": "integer", + "description": "Quantos dias antes do evento ele será exibido (optional)", + "format": "int32" + }, + "diasDepoisEvento": { + "type": "integer", + "description": "Até quantos dias depois do evento ele será exibido (optional)", + "format": "int32" + }, + "urlLogo": { + "type": "string", + "description": "Url do Logo. (Base64)" + }, + "urlCapa": { + "type": "string", + "description": "Url da Capa. (Base64)" + }, + "proprietario": { + "type": "string", + "description": "Quem é o proprietário" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 01 será habilitada" + }, + "textoInfo01": { + "type": "string", + "description": "Texto para o campo informação 01 (optional)" + }, + "conteudoInfo01": { + "type": "string", + "description": "Conteúdo para o campo informação 01 (optional)" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "description": "Se a aba de informação 02 será habilitada" + }, + "textoInfo02": { + "type": "string", + "description": "Texto para o campo informação 02 (optional)" + }, + "conteudoInfo02": { + "type": "string", + "description": "Conteúdo para o campo informação 02 (optional)" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "description": "Se a aba de mensagem será habilitada (optional)" + }, + "enumTipoListaPresenteId": { + "type": "string", + "description": "Tipo de lista de presente", + "enum": [ + "ListaPronta", + "ListaManual" + ] + }, + "enumTipoEntregaId": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "eventoProdutoSelecionado": { + "type": "array", + "description": "Seleção de produto no evento", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante", + "format": "int32" + }, + "recebidoForaLista": { + "type": "boolean", + "description": "Se produto recebido fora da lista (optional)" + }, + "removido": { + "type": "boolean", + "description": "Se produto removido (optional)" + } + }, + "type": "object" + } + }, + "enderecoEvento": { + "type": "array", + "description": "Endereço do Evento", + "items": { + "properties": { + "nome": { + "type": "string", + "description": "Nome para identificação do endereço" + }, + "endereco": { + "type": "string", + "description": "Endereço" + }, + "cep": { + "type": "string", + "description": "Cep do endereço" + }, + "numero": { + "type": "string", + "description": "Numero do endereço" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço" + }, + "cidade": { + "type": "string", + "description": "Cidade do endereço" + }, + "estado": { + "type": "string", + "description": "Estado do endereço" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac815a9efce0039082096a" +} \ No newline at end of file diff --git a/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json b/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json new file mode 100644 index 000000000..c36202129 --- /dev/null +++ b/wake/utils/openapi/define-uma-categoria-de-um-produto-como-principal.openapi.json @@ -0,0 +1,142 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/categoriaPrincipal": { + "put": { + "summary": "Define uma categoria de um produto como principal", + "description": "", + "operationId": "define-uma-categoria-de-um-produto-como-principal", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "categoriaId": { + "type": "integer", + "description": "Id da categoria", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c467f517331b00b6c6396b" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json b/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json new file mode 100644 index 000000000..a8aee2246 --- /dev/null +++ b/wake/utils/openapi/deleta-o-seo-de-um-produto-especifico.openapi.json @@ -0,0 +1,115 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo": { + "delete": { + "summary": "Deleta o SEO de um produto específico", + "description": "", + "operationId": "deleta-o-seo-de-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c49a83317888003b3a6129" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json new file mode 100644 index 000000000..21fbdfbaf --- /dev/null +++ b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico.openapi.json @@ -0,0 +1,165 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/hotsites": { + "delete": { + "summary": "Deleta o vinculo de um ou mais hotsites com um banner específico", + "description": "", + "operationId": "deleta-o-vinculo-de-um-ou-mais-hotsites-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve desvincular os hotsites desejados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "listaHotsites": { + "type": "object", + "description": "Lista de identificadores de hotsites para desvincular do banner (optional)", + "properties": { + "hotSiteId": { + "type": "array", + "description": "Id do hotsite para vinculo com banner", + "items": { + "properties": { + "hotSiteId": { + "type": "array", + "description": "Id do hotsite para vinculo com banner", + "default": [] + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a747f036263e0027566bfb" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json new file mode 100644 index 000000000..4ce51e40b --- /dev/null +++ b/wake/utils/openapi/deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/parceiros": { + "delete": { + "summary": "Deleta o vinculo de um ou mais parceiros com um banner específico", + "description": "", + "operationId": "deleta-o-vinculo-de-um-ou-mais-parceiros-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve desvincular os parceiros desejados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "listaParceiros": { + "type": "array", + "description": "Lista de identificadores de parceiros para desvincular do banner", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7691a93536400345f5633" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json b/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json new file mode 100644 index 000000000..786607c53 --- /dev/null +++ b/wake/utils/openapi/deleta-o-vinculo-de-um-produto-a-um-evento.openapi.json @@ -0,0 +1,148 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}/produto/{produtoVarianteId}": { + "delete": { + "summary": "Deleta o vinculo de um produto a um evento", + "description": "", + "operationId": "deleta-o-vinculo-de-um-produto-a-um-evento", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Identificador do variante do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "\"Produto desvinculado com sucesso!\"": { + "value": "\"Produto desvinculado com sucesso!\"" + } + }, + "schema": { + "type": "string", + "example": "Produto desvinculado com sucesso!" + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac8e39e66b3800148635e3" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-atributo.openapi.json b/wake/utils/openapi/deleta-um-atributo.openapi.json new file mode 100644 index 000000000..7693a9c76 --- /dev/null +++ b/wake/utils/openapi/deleta-um-atributo.openapi.json @@ -0,0 +1,133 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/atributos/{nome}": { + "delete": { + "summary": "Deleta um atributo", + "description": "", + "operationId": "deleta-um-atributo", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0ee0071a9a9003ad8bb79" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json b/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json new file mode 100644 index 000000000..5ad616e37 --- /dev/null +++ b/wake/utils/openapi/deleta-um-avatar-de-um-usuario.openapi.json @@ -0,0 +1,102 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/avatar": { + "delete": { + "summary": "Deleta um avatar de um usuário", + "description": "", + "operationId": "deleta-um-avatar-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec25dfb1b9902beda6b44" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-banner-existente.openapi.json b/wake/utils/openapi/deleta-um-banner-existente.openapi.json new file mode 100644 index 000000000..95a648aa0 --- /dev/null +++ b/wake/utils/openapi/deleta-um-banner-existente.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}": { + "delete": { + "summary": "Deleta um banner existente", + "description": "", + "operationId": "deleta-um-banner-existente", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve ser deletado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a34cd384de520013cdef50" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json b/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json new file mode 100644 index 000000000..176dffacd --- /dev/null +++ b/wake/utils/openapi/deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}": { + "delete": { + "summary": "Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados", + "description": "", + "operationId": "deleta-um-hotsite-que-foi-inserido-manualmente-hotsites-gerados-automaticamente-nao-podem-ser-deletados", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser deletado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a89922544600001d879d98" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json b/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json new file mode 100644 index 000000000..5e8b7cc69 --- /dev/null +++ b/wake/utils/openapi/deleta-um-ou-mais-metatags-de-produto.openapi.json @@ -0,0 +1,140 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo/metaTag": { + "delete": { + "summary": "Deleta um ou mais Metatags de produto", + "description": "", + "operationId": "deleta-um-ou-mais-metatags-de-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metatags": { + "type": "array", + "description": "Lista de identificadores de metatags (optional)", + "items": { + "properties": { + "metatagId": { + "type": "integer", + "description": "Identificador do MetaTag", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c57651bf9a8f077c21747d" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-portfolio.openapi.json b/wake/utils/openapi/deleta-um-portfolio.openapi.json new file mode 100644 index 000000000..c3d9c4fca --- /dev/null +++ b/wake/utils/openapi/deleta-um-portfolio.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}": { + "delete": { + "summary": "Deleta um portfolio", + "description": "", + "operationId": "deleta-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja excluir", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef1802129b700693025c0" +} \ No newline at end of file diff --git a/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json b/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json new file mode 100644 index 000000000..2902bdd63 --- /dev/null +++ b/wake/utils/openapi/deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento.openapi.json @@ -0,0 +1,113 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}/produto/{produtoVarianteId}": { + "delete": { + "summary": "Deleta um produto da lista de sugestões de produtos de um tipo de evento", + "description": "", + "operationId": "deleta-um-produto-da-lista-de-sugestoes-de-produtos-de-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Identificador do variante do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ced108313480037cbf7038" +} \ No newline at end of file diff --git a/wake/utils/openapi/deletar-autor.openapi.json b/wake/utils/openapi/deletar-autor.openapi.json new file mode 100644 index 000000000..b4982411d --- /dev/null +++ b/wake/utils/openapi/deletar-autor.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores/{autorId}": { + "delete": { + "summary": "Deletar autor", + "description": "", + "operationId": "deletar-autor", + "parameters": [ + { + "name": "autorId", + "in": "path", + "description": "Identificador do autor", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a1067e55e8290036bc96c3" +} \ No newline at end of file diff --git a/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json b/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..52fd84d12 --- /dev/null +++ b/wake/utils/openapi/desvincula-um-ou-mais-banners-de-um-hotsite-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/banners": { + "delete": { + "summary": "Desvincula um ou mais banners de um hotsite específico", + "description": "", + "operationId": "desvincula-um-ou-mais-banners-de-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser desvinculado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem desvinculados", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a89c86f39f1007ccd51a18" +} \ No newline at end of file diff --git a/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json b/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..66e74c394 --- /dev/null +++ b/wake/utils/openapi/desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/conteudos": { + "delete": { + "summary": "Desvincula um ou mais conteúdos de um hotsite específico", + "description": "", + "operationId": "desvincula-um-ou-mais-conteudos-de-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser desvinculado os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem desvinculados", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a8dc7781fdca00562277c5" +} \ No newline at end of file diff --git a/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json b/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json new file mode 100644 index 000000000..67b5623ce --- /dev/null +++ b/wake/utils/openapi/estorna-total-ou-parcial-de-um-pedido.openapi.json @@ -0,0 +1,151 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/estorno/{pedidoId}": { + "post": { + "summary": "Estorna total ou parcial de um pedido", + "description": "Estorna um valor menor ou igual ao total do pedido \"Pago\"", + "operationId": "estorna-total-ou-parcial-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "Valor": { + "type": "number", + "description": "Valor a ser estornado do pedido. Total ou parcial.", + "default": null, + "format": "float" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:648a233482a9bc000a9d91f0" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json b/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json new file mode 100644 index 000000000..3d5450e7d --- /dev/null +++ b/wake/utils/openapi/exclui-o-vinculo-entre-uma-categoria-e-um-produto.openapi.json @@ -0,0 +1,136 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/categorias/{id}": { + "delete": { + "summary": "Exclui o vínculo entre uma categoria e um produto", + "description": "", + "operationId": "exclui-o-vinculo-entre-uma-categoria-e-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "id", + "in": "path", + "description": "Id da categoria a qual o produto deverá ser desvinculado", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4525d69aab3006b814790" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json b/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json new file mode 100644 index 000000000..c890f85c3 --- /dev/null +++ b/wake/utils/openapi/exclui-os-detalhes-de-um-contrato-de-frete.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}/detalhes": { + "delete": { + "summary": "Exclui os detalhes de um contrato de frete", + "description": "", + "operationId": "exclui-os-detalhes-de-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d3726b567b00ae9c7d66" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-fabricante.openapi.json b/wake/utils/openapi/exclui-um-fabricante.openapi.json new file mode 100644 index 000000000..9d9b661b4 --- /dev/null +++ b/wake/utils/openapi/exclui-um-fabricante.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes/{fabricanteId}": { + "delete": { + "summary": "Exclui um fabricante", + "description": "", + "operationId": "exclui-um-fabricante", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0837883dd8c00404e4c66" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-parceiro.openapi.json b/wake/utils/openapi/exclui-um-parceiro.openapi.json new file mode 100644 index 000000000..fe3599e65 --- /dev/null +++ b/wake/utils/openapi/exclui-um-parceiro.openapi.json @@ -0,0 +1,122 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{parceiroId}": { + "delete": { + "summary": "Exclui um parceiro", + "description": "Parceiro excluído com sucesso", + "operationId": "exclui-um-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb2c519a3d800464c2464" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-um-script.openapi.json b/wake/utils/openapi/exclui-um-script.openapi.json new file mode 100644 index 000000000..3838b107e --- /dev/null +++ b/wake/utils/openapi/exclui-um-script.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts/{scriptId}": { + "delete": { + "summary": "Exclui um Script", + "description": "", + "operationId": "exclui-um-script", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b4522a9f03910096195e76" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json new file mode 100644 index 000000000..0d275ea1e --- /dev/null +++ b/wake/utils/openapi/exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/erp/{id}": { + "delete": { + "summary": "Exclui uma categoria utilizando o id do erp como identificador", + "description": "Categoria excluída com sucesso", + "operationId": "exclui-uma-categoria-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa0a6aad28090027004824" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-categoria.openapi.json b/wake/utils/openapi/exclui-uma-categoria.openapi.json new file mode 100644 index 000000000..c00ece4d8 --- /dev/null +++ b/wake/utils/openapi/exclui-uma-categoria.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/{id}": { + "delete": { + "summary": "Exclui uma categoria", + "description": "", + "operationId": "exclui-uma-categoria", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a9f29c4caa3800382a6f51" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json b/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json new file mode 100644 index 000000000..df9941b0e --- /dev/null +++ b/wake/utils/openapi/exclui-uma-imagem-de-um-produto.openapi.json @@ -0,0 +1,136 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/imagens/{id}": { + "delete": { + "summary": "Exclui uma imagem de um produto", + "description": "", + "operationId": "exclui-uma-imagem-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "id", + "in": "path", + "description": "Id da imagem do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c46d4db2f76f00aa944392" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json b/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json new file mode 100644 index 000000000..3f11e5720 --- /dev/null +++ b/wake/utils/openapi/exclui-uma-informacao-de-um-produto.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/informacoes/{informacaoId}": { + "delete": { + "summary": "Exclui uma informação de um produto", + "description": "", + "operationId": "exclui-uma-informacao-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "informacaoId", + "in": "path", + "description": "Id da informação do produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c448a7873944006eb782d0" +} \ No newline at end of file diff --git a/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..f769cd830 --- /dev/null +++ b/wake/utils/openapi/exclui-uma-tabela-de-precos.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}": { + "delete": { + "summary": "Exclui uma tabela de preços", + "description": "", + "operationId": "exclui-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a7f9b0c9350027e96a00" +} \ No newline at end of file diff --git a/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json b/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json new file mode 100644 index 000000000..435ecb50b --- /dev/null +++ b/wake/utils/openapi/executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1.openapi.json @@ -0,0 +1,158 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/centrosdistribuicao/{centroDistribuicaoId}/prioridade": { + "put": { + "summary": "Executa uma atualizacao da prioridade do centro de distribuicao", + "description": "Atualiza a prioridade de um centro de distribuição", + "operationId": "executa-uma-atualizacao-da-prioridade-do-centro-de-distribuicao-1", + "parameters": [ + { + "name": "centroDistribuicaoId", + "in": "path", + "description": "Id do centro de distribuição", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "incrementoOrdem": { + "type": "integer", + "description": "(optional)", + "format": "int32" + }, + "desativarPriorizacao": { + "type": "boolean", + "description": "(optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no Processamento da Operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no Processamento da Operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:64be95e5b78c82006347bf61" +} \ No newline at end of file diff --git a/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json b/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json new file mode 100644 index 000000000..81e03d90a --- /dev/null +++ b/wake/utils/openapi/gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data.openapi.json @@ -0,0 +1,111 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autenticacao/refresh": { + "post": { + "summary": "Gera um novo access token baseado em um access token expirado por data", + "description": "Access token atualizado com sucesso", + "operationId": "gera-um-novo-access-token-baseado-em-um-access-token-expirado-por-data", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.420Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojas": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "accessToken": { + "type": "string", + "example": "string" + }, + "dataExpiracaoAccessTokenUTC": { + "type": "string", + "example": "2022-06-09T11:21:37.420Z" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a226cab72af600215e6b78" +} \ No newline at end of file diff --git a/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json b/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json new file mode 100644 index 000000000..1ad5e6786 --- /dev/null +++ b/wake/utils/openapi/gera-um-novo-pedido-para-a-assinatura.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}/pedido": { + "post": { + "summary": "Gera um novo pedido para a assinatura", + "description": "", + "operationId": "gera-um-novo-pedido-para-a-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Identificador da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a723a3b41b840051dffa8e" +} \ No newline at end of file diff --git a/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json b/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json new file mode 100644 index 000000000..8c17ff2a4 --- /dev/null +++ b/wake/utils/openapi/indicador-do-carrinho-abandonado.openapi.json @@ -0,0 +1,151 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/carrinhoabandonado": { + "get": { + "summary": "Indicador do Carrinho Abandonado", + "description": "Indicador do Carrinho Abandonado", + "operationId": "indicador-do-carrinho-abandonado", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorCarrinhoAbandonado\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorCarrinhoAbandonado": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4130800ea80090d9ee0b" +} \ No newline at end of file diff --git a/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json b/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json new file mode 100644 index 000000000..b79f09c53 --- /dev/null +++ b/wake/utils/openapi/indicador-dos-novos-compradores.openapi.json @@ -0,0 +1,151 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/novoscompradores": { + "get": { + "summary": "Indicador dos Novos Compradores", + "description": "Indicador dos Novos Compradores", + "operationId": "indicador-dos-novos-compradores", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos novos compradores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorComprador\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorComprador": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa3fa86afe2b0086c77851" +} \ No newline at end of file diff --git a/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json b/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json new file mode 100644 index 000000000..2d71dd143 --- /dev/null +++ b/wake/utils/openapi/indicadores-dos-produtos-no-estoque.openapi.json @@ -0,0 +1,155 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/produtoestoque": { + "get": { + "summary": "Indicadores dos Produtos no Estoque", + "description": "Indicadores dos Produtos no Estoque", + "operationId": "indicadores-dos-produtos-no-estoque", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorProdutoComEstoque\": \"string\",\n \"indicadorProdutoSemEstoque\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorProdutoComEstoque": { + "type": "string", + "example": "string" + }, + "indicadorProdutoSemEstoque": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4078cbd4e30014d40c44" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json b/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json new file mode 100644 index 000000000..3710afa42 --- /dev/null +++ b/wake/utils/openapi/insere-limite-de-credito-para-um-usuario.openapi.json @@ -0,0 +1,120 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/limiteCredito/{usuarioId}": { + "put": { + "summary": "Atualiza o limite de crédito para um usuário", + "description": "", + "operationId": "insere-limite-de-credito-para-um-usuario", + "parameters": [ + { + "name": "cpf_cnpj", + "in": "query", + "description": "CPF ou CNPJ do usuário", + "schema": { + "type": "string" + } + }, + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "valor", + "in": "query", + "description": "Valor do limite de crédito", + "schema": { + "type": "number", + "format": "double" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de9462609d1c006fd1e913" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json new file mode 100644 index 000000000..60da46408 --- /dev/null +++ b/wake/utils/openapi/insere-um-endereco-para-um-usuario-pelo-id-do-usuario.openapi.json @@ -0,0 +1,150 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}/enderecos": { + "post": { + "summary": "Insere um endereço para um usuário pelo id do usuário", + "description": "", + "operationId": "insere-um-endereco-para-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dad570ff4a61001a38ebf3" +} \ No newline at end of file diff --git "a/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" "b/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" new file mode 100644 index 000000000..fedfaa8b7 --- /dev/null +++ "b/wake/utils/openapi/insere-um-endere\303\247o-para-um-usuario-pelo-e-mail.openapi.json" @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/enderecos": { + "post": { + "summary": "Insere um endereço para um usuário pelo e-mail", + "description": "", + "operationId": "insere-um-endereço-para-um-usuario-pelo-e-mail", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nomeEndereco": { + "type": "string", + "description": "Nome de identificação do endereço a ser cadastrado (Max Length: 100)" + }, + "rua": { + "type": "string", + "description": "Nome da rua (Max Length: 500)" + }, + "numero": { + "type": "string", + "description": "Número do local (Max Length: 50)" + }, + "complemento": { + "type": "string", + "description": "Complemento (Max Length: 250) (optional)" + }, + "referencia": { + "type": "string", + "description": "Referência para a localização do endereço (Max Length: 500) (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço (Max Length: 100)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que se localiza o endereço (Max Length: 100)" + }, + "estado": { + "type": "string", + "description": "O estado (Max Length: 100)" + }, + "cep": { + "type": "string", + "description": "Código do cep (Max Length: 50)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62daad403871a90037c1d87e" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-atributo.openapi.json b/wake/utils/openapi/insere-um-novo-atributo.openapi.json new file mode 100644 index 000000000..3029df96f --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-atributo.openapi.json @@ -0,0 +1,164 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/atributos": { + "post": { + "summary": "Insere um novo atributo", + "description": "", + "operationId": "insere-um-novo-atributo", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do atributo (optional)" + }, + "tipo": { + "type": "string", + "description": "Tipo do atributo (optional)", + "enum": [ + "Selecao", + "Filtro", + "Comparacao", + "Configuracao", + "ExclusivoGoogle" + ] + }, + "tipoExibicao": { + "type": "string", + "description": "Tipo de exibição (optional)", + "enum": [ + "Combo", + "Div", + "DivComCor", + "DivComFotoDoProdutoVariante", + "Javascript" + ] + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do atributo (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "501": { + "description": "501", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0e8bcf02cdd004907a1c4" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json b/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json new file mode 100644 index 000000000..b400a4936 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-avatar-para-o-usuario.openapi.json @@ -0,0 +1,130 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/avatar": { + "post": { + "summary": "Insere um novo avatar para o usuário", + "description": "", + "operationId": "insere-um-novo-avatar-para-o-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "base64": { + "type": "string", + "description": "Imagem do avatar em base64 (optional)" + }, + "formato": { + "type": "string", + "description": "Formato da imagem (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Nome do arquivo gerado": { + "value": "{\n \"urlAvatar\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "urlAvatar": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec2dcc9cecb012fb4e625" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-banner.openapi.json b/wake/utils/openapi/insere-um-novo-banner.openapi.json new file mode 100644 index 000000000..990528a68 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-banner.openapi.json @@ -0,0 +1,336 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners": { + "post": { + "summary": "Insere um novo banner", + "description": "", + "operationId": "insere-um-novo-banner", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do banner" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do banner", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data de termino de exibição do banner (optional)", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Banner ativo/inativo (optional)" + }, + "detalhe": { + "type": "object", + "description": "Detalhes do banner", + "properties": { + "posicionamentoId": { + "type": "integer", + "description": "Local de posicionamento do banner", + "format": "int32" + }, + "imagemBanner": { + "type": "object", + "description": "Imagem do banner (caso o campo \"UrlBanner\" estiver preenchido esse campo será desconsiderado) (optional)", + "properties": { + "base64": { + "type": "string", + "description": "string da imagem em base 64" + }, + "formato": { + "type": "string", + "description": "formato da imagem", + "enum": [ + "PNG", + "JPG", + "JPEG" + ] + }, + "nome": { + "type": "string", + "description": "nome da imagem" + } + } + }, + "urlBanner": { + "type": "string", + "description": "Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional)" + }, + "ordemExibicao": { + "type": "integer", + "description": "Ordem de exibição do banner (optional)", + "format": "int32" + }, + "abrirLinkNovaAba": { + "type": "boolean", + "description": "Se o banner deve ou não abrir em nova aba (optional)" + }, + "largura": { + "type": "integer", + "description": "Largura do banner em pixels (optional)", + "format": "int32" + }, + "altura": { + "type": "integer", + "description": "Altura do banner em pixels (optional)", + "format": "int32" + }, + "title": { + "type": "string", + "description": "Title da imagem do banner (optional)" + }, + "urlClique": { + "type": "string", + "description": "Url de destino para quando o usuário clicar no Banner (optional)" + }, + "urlBannerAlternativo": { + "type": "string", + "description": "URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional)" + }, + "textoAlternativo": { + "type": "string", + "description": "Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner" + } + } + }, + "diasExibicao": { + "type": "object", + "description": "Dias da semana que o banner deverá ser exibido (optional)", + "properties": { + "todosDias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como \"true\" os demais serão desconsiderados)" + }, + "domingo": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no domingo" + }, + "segunda": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na segunda" + }, + "terca": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na terça" + }, + "quarta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quarta" + }, + "quinta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na quinta" + }, + "sexta": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado na sexta" + }, + "sabado": { + "type": "boolean", + "description": "Se o banner deverá ser apresentado no sábado" + } + } + }, + "apresentacao": { + "type": "object", + "description": "Detalhes de apresentação do banner (optional)", + "properties": { + "exibirNoSite": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todo o site" + }, + "exibirEmTodasBuscas": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas as buscas" + }, + "naoExibirEmBuscas": { + "type": "boolean", + "description": "Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "termosBusca": { + "type": "string", + "description": "Termos que o banner será exibido na busca" + }, + "exibirEmTodasCategorias": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado)" + }, + "listaHotsites": { + "type": "object", + "description": "Em quais hotsites o banner deve ser exibido", + "properties": { + "exibirEmTodosHotsites": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como \"true\" o campo HotSites será desconsiderado) (optional)" + }, + "hotsites": { + "type": "array", + "description": "Lista de hotsite's que o banner será exibido", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + }, + "listaParceiros": { + "type": "object", + "description": "Em quais parceiros o banner deve ser exibido", + "properties": { + "exibirEmTodosParceiros": { + "type": "boolean", + "description": "Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como \"true\" o campo TermosBusca será desconsiderado) (optional)" + }, + "parceiros": { + "type": "array", + "description": "Lista de parceiros que o banner será exibido", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a73d79fc8d2200f3244bc0" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json b/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json new file mode 100644 index 000000000..0ba261157 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-campo-de-cadastro-personalizado.openapi.json @@ -0,0 +1,142 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/CadastroPersonalizado": { + "post": { + "summary": "Insere um novo campo de cadastro personalizado", + "description": "", + "operationId": "insere-um-novo-campo-de-cadastro-personalizado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do campo" + }, + "tipo": { + "type": "string", + "description": "Tipo do campo", + "enum": [ + "TextoLivre", + "ValoresPredefinidos", + "RadioButton" + ] + }, + "obrigatorio": { + "type": "boolean", + "description": "Se o campo será obrigatório" + }, + "ordem": { + "type": "integer", + "description": "Ordem", + "format": "int32" + }, + "valorPreDefinido": { + "type": "array", + "description": "Informação para os campos (optional)", + "items": { + "properties": { + "valor": { + "type": "string", + "description": "Valor" + }, + "ordem": { + "type": "integer", + "description": "Ordem", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do campo de cadastro personalizado gerado": { + "value": "Id do campo de cadastro personalizado gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec4fbe00703012ad1342f" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json b/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json new file mode 100644 index 000000000..7ab745dca --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-conteudo-na-loja.openapi.json @@ -0,0 +1,192 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/conteudos": { + "post": { + "summary": "Insere um novo conteúdo na loja", + "description": "", + "operationId": "insere-um-novo-conteudo-na-loja", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "titulo": { + "type": "string", + "description": "Titulo do conteúdo" + }, + "ativo": { + "type": "boolean", + "description": "Conteúdo ativo/inativo" + }, + "dataInicio": { + "type": "string", + "description": "Data de inicio de exibição do conteúdo (optional)", + "format": "date" + }, + "dataFim": { + "type": "string", + "description": "Data final de exibição do conteúdo (optional)", + "format": "date" + }, + "posicionamento": { + "type": "string", + "description": "Posicionamento do conteúdo", + "enum": [ + "Topo", + "Centro", + "Rodape", + "LateralDireita", + "LateralEsquerda", + "MobileTopo", + "MobileRodape" + ] + }, + "conteudo": { + "type": "string", + "description": "Informações do conteúdo" + }, + "termoBusca": { + "type": "string", + "description": "Insira em qual Termo de Busca o Conteúdo será exibido (optional)" + }, + "exibeTodasBuscas": { + "type": "boolean", + "description": "Exibição do conteúdo nas buscas" + }, + "naoExibeBuscas": { + "type": "boolean", + "description": "Não exibição do conteúdo nas buscas" + }, + "exibeTodosHotsites": { + "type": "boolean", + "description": "Exibição do conteúdo nos hotsites" + }, + "hotsitesId": { + "type": "array", + "description": "Insira quais Hotsites que o Conteúdo será exibido (optional)", + "items": { + "type": "integer", + "format": "int32" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a8723026857d003565d195" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json b/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json new file mode 100644 index 000000000..6fad6e2ec --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-contrato-de-frete.openapi.json @@ -0,0 +1,204 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes": { + "post": { + "summary": "Insere um novo contrato de frete", + "description": "", + "operationId": "insere-um-novo-contrato-de-frete", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do contrato de frete (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Status do contrato de frete (optional)" + }, + "volumeMaximo": { + "type": "integer", + "description": "Volume máximo permitido , em metro cúbico (m³). (optional)", + "format": "int32" + }, + "pesoCubado": { + "type": "number", + "description": "Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional)", + "format": "double" + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "description": "Id da configuração entrega agendada (optional)", + "format": "int32" + }, + "linkRastreamento": { + "type": "string", + "description": "URL rastreamento (optional)" + }, + "ehAssinatura": { + "type": "boolean", + "description": "Contrato é exclusivo assinatura (optional)" + }, + "larguraMaxima": { + "type": "integer", + "description": "Informe a largura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "alturaMaxima": { + "type": "integer", + "description": "Informe a altura máxima, em centímetros (cm). (optional)", + "format": "int32" + }, + "comprimentoMaximo": { + "type": "integer", + "description": "Informe o comprimento máximo, em centímetros (cm). (optional)", + "format": "int32" + }, + "limiteMaximoDimensoes": { + "type": "integer", + "description": "Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional)", + "format": "int32" + }, + "limitePesoCubado": { + "type": "number", + "description": "Informe o limite de peso cubado, em gramas (g). (optional)", + "format": "double" + }, + "tempoMinimoDespacho": { + "type": "integer", + "description": "Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Informe o Id do centro de distribuição (optional)", + "format": "int32" + }, + "valorMinimoProdutos": { + "type": "number", + "description": "Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional)", + "format": "double" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do frete gerado": { + "value": "Id do frete gerado" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0a6af7953870133270d58" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json b/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json new file mode 100644 index 000000000..462251bb9 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete.openapi.json @@ -0,0 +1,194 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}/detalhes": { + "post": { + "summary": "Insere um novo detalhe de frete vinculado a um contrato de frete", + "description": "", + "operationId": "insere-um-novo-detalhe-de-frete-vinculado-a-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "cepInicial": { + "type": "integer", + "description": "Informe o cep inicial (optional)", + "format": "int32" + }, + "cepFinal": { + "type": "integer", + "description": "Informe o cep final (optional)", + "format": "int32" + }, + "variacoesFreteDetalhe": { + "type": "array", + "description": "Variações de detalhe do frete (optional)", + "items": { + "properties": { + "pesoInicial": { + "type": "number", + "description": "Informe o peso inicial", + "format": "double" + }, + "pesoFinal": { + "type": "number", + "description": "Informe o peso final", + "format": "double" + }, + "valorFrete": { + "type": "number", + "description": "Informe o valor do frete", + "format": "double" + }, + "prazoEntrega": { + "type": "number", + "description": "Informe o prazo de entrega", + "format": "double" + }, + "valorPreco": { + "type": "number", + "description": "Informe o valor preço", + "format": "double" + }, + "valorPeso": { + "type": "number", + "description": "Informe o valor peso", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Detalhes de frete inserido com sucesso": { + "value": "Detalhes de frete inserido com sucesso" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d42276643100982d7acb" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-fabricante.openapi.json b/wake/utils/openapi/insere-um-novo-fabricante.openapi.json new file mode 100644 index 000000000..27f4ce2fb --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-fabricante.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes": { + "post": { + "summary": "Insere um novo fabricante", + "description": "", + "operationId": "insere-um-novo-fabricante", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do fabricante (optional)" + }, + "urlLogoTipo": { + "type": "string", + "description": "URL tipo logo (optional)" + }, + "urlLink": { + "type": "string", + "description": "Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional)" + }, + "urlCarrossel": { + "type": "string", + "description": "Insira nesse campo a URL do Carrossel da Marca (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do fabricante gerado": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b05fffd74efd002f605f51" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-hotsite.openapi.json b/wake/utils/openapi/insere-um-novo-hotsite.openapi.json new file mode 100644 index 000000000..a7c801215 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-hotsite.openapi.json @@ -0,0 +1,274 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites": { + "post": { + "summary": "Insere um novo hotsite", + "description": "A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos.", + "operationId": "insere-um-novo-hotsite", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do hotsite" + }, + "dataInicio": { + "type": "string", + "description": "Data/hora em que o hotsite começará a ser exibido (optional)", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data/Hora (último dia) em que o hotsite não será mais exibido (optional)", + "format": "date" + }, + "url": { + "type": "string", + "description": "Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início" + }, + "tamanhoPagina": { + "type": "integer", + "description": "Informe o número de produtos que deve ser exibido por página", + "format": "int32" + }, + "templateId": { + "type": "integer", + "description": "Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates", + "format": "int32" + }, + "ordenacao": { + "type": "string", + "description": "Informe qual será a ordenação dos Produtos no Hotsite (optional)", + "enum": [ + "Nenhuma", + "NomeCrescente", + "NomeDecrescente", + "Lancamento", + "MenorPreco", + "MaiorPreco", + "MaisVendidos", + "MaioresDescontos", + "Aleatorio", + "MenorEstoque", + "MaiorEstoque" + ] + }, + "listaProdutos": { + "type": "object", + "description": "Produtos que devem aparecer no hotsite", + "properties": { + "expressao": { + "type": "string", + "description": "você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional)" + }, + "produtos": { + "type": "array", + "description": "Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Identificador do produto a ser mostrado no hotsite", + "format": "int32" + }, + "ordem": { + "type": "integer", + "description": "Ordem para apresentação do produto (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "seo": { + "type": "object", + "description": "Dados de seo (optional)", + "properties": { + "titulo": { + "type": "string", + "description": "Informe o Título que será exibido quando o Hotsite for acessado (optional)" + }, + "metas": { + "type": "array", + "description": "Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional)", + "items": { + "properties": { + "conteudo": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "nome": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "httpEquiv": { + "type": "string", + "description": "Informe os dados da Metatag" + }, + "scheme": { + "type": "string", + "description": "Informe os dados da Metatag" + } + }, + "type": "object" + } + } + } + }, + "banners": { + "type": "array", + "description": "Lista de identificadores de banners a serem vinculados ao hotsite (optional)", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + }, + "conteudos": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados ao hotsite", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + }, + "ativo": { + "type": "boolean", + "description": "Status do hotsite (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a88c6540fc1d074a0e9fb2" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-parceiro.openapi.json b/wake/utils/openapi/insere-um-novo-parceiro.openapi.json new file mode 100644 index 000000000..565235414 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-parceiro.openapi.json @@ -0,0 +1,137 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros": { + "post": { + "summary": "Insere um novo parceiro", + "description": "", + "operationId": "insere-um-novo-parceiro", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro" + }, + "tabelaPrecoId": { + "type": "integer", + "description": "Id da tabela de preço (optional)", + "format": "int32" + }, + "portfolioId": { + "type": "integer", + "description": "Id do portfolio (optional)", + "format": "int32" + }, + "tipoEscopo": { + "type": "string", + "description": "Tipo de escopo", + "enum": [ + "Aberto\"", + "Fechado", + "PorCliente" + ] + }, + "ativo": { + "type": "boolean", + "description": "Status do parceiro" + }, + "isMarketPlace": { + "type": "boolean", + "description": "Se o parceiro é marketplace (optional)" + }, + "origem": { + "type": "string", + "description": "Origem (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do parceiro gerado": { + "value": "\tId do parceiro gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdabae2efc110028adb899" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-pedido.openapi.json b/wake/utils/openapi/insere-um-novo-pedido.openapi.json new file mode 100644 index 000000000..5a60a887c --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-pedido.openapi.json @@ -0,0 +1,442 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos": { + "post": { + "summary": "Insere um novo pedido", + "description": "Caso a loja utilize as formas de pagamento do gateway o campo \"formaPagamentoId\" do objeto \"pagamento\" deverá conter o valor \"200\".", + "operationId": "insere-um-novo-pedido", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional)", + "format": "int32" + }, + "carrinhoId": { + "type": "string", + "description": "Id do carrinho que foi utilizado no pedido (optional)" + }, + "situacaoPedidoId": { + "type": "integer", + "description": "Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido", + "format": "int32" + }, + "data": { + "type": "string", + "description": "Data em que o pedido foi realizado", + "format": "date" + }, + "valorTotal": { + "type": "number", + "description": "Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional)", + "format": "double" + }, + "valorJuros": { + "type": "number", + "description": "Informação do juros do pedido", + "format": "double" + }, + "valorDesconto": { + "type": "number", + "description": "Informação de desconto do pedido", + "format": "double" + }, + "usuarioId": { + "type": "integer", + "description": "Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios", + "format": "int32" + }, + "enderecoId": { + "type": "integer", + "description": "Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos", + "format": "int32" + }, + "isMobile": { + "type": "boolean", + "description": "Define se o pedido foi feito através de um dispositivo móvel ou não" + }, + "eventoId": { + "type": "integer", + "description": "Id do evento ao qual o pedido está vinculado (opcional)", + "format": "int32" + }, + "produtos": { + "type": "array", + "description": "Lista contendo os produtos do pedido", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Id do produto variante que está vinculado a esse pedido.", + "format": "int32" + }, + "quantidade": { + "type": "object", + "description": "Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição", + "properties": { + "quantidadeTotal": { + "type": "integer", + "description": "Quantidade por centro de distribuição", + "format": "int32" + }, + "quantidadePorCentroDeDistribuicao": { + "type": "array", + "description": "Quantidade (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade", + "format": "int32" + } + }, + "type": "object" + } + } + } + }, + "precoVenda": { + "type": "number", + "description": "Preço de venda do produto, sem adição ou subtração de valores.", + "format": "double" + }, + "isBrinde": { + "type": "boolean", + "description": "Define se esse produto é um brinde ou não" + }, + "ajustes": { + "type": "array", + "description": "Lista contendo todos os ajustes de preço do produto", + "items": { + "properties": { + "tipo": { + "type": "string", + "description": "Define o tipo do ajuste de valor de um produto contido em um pedido. = ['Frete', 'Pricing', 'Atacarejo', 'Personalizacao', 'Embalagem', 'Promocao', 'PromocaoFrete', 'ContaCorrente', 'FormaPagamento', 'PromocaoProduto', 'TipoFreteProduto', 'Formula']stringEnum:\"Frete\", \"Pricing\", \"Atacarejo\", \"Personalizacao\", \"Embalagem\", \"Promocao\", \"PromocaoFrete\", \"ContaCorrente\", \"FormaPagamento\", \"PromocaoProduto\", \"TipoFreteProduto\", \"Formula\"" + }, + "valor": { + "type": "number", + "description": "Define o valor do ajuste a ser aplicado no produto. O valor pode ser positivo ou negativo", + "format": "double" + }, + "observacao": { + "type": "string", + "description": "Observação (optional)" + }, + "nome": { + "type": "string", + "description": "Nome (optional)" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + }, + "fretes": { + "type": "array", + "description": "Informações de frete do pedido", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Identificador do centro de distribuição de origem", + "format": "int32" + }, + "freteContratoId": { + "type": "integer", + "description": "Identificador do contrato de frete (optional)", + "format": "int32" + }, + "peso": { + "type": "number", + "description": "Peso em gramas (g) do frete calculado (optional)", + "format": "double" + }, + "pesoCobrado": { + "type": "number", + "description": "Peso em gramas cobrado do cliente (optional)", + "format": "double" + }, + "volume": { + "type": "number", + "description": "Volume em metro cúbico (m³) calculado (optional)", + "format": "double" + }, + "volumeCobrado": { + "type": "number", + "description": "Volume em metro cúbico (m³) cobrado do cliente (optional)", + "format": "double" + }, + "prazoEnvio": { + "type": "integer", + "description": "Prazo do envio do frete em dias úteis", + "format": "int32" + }, + "valorFreteEmpresa": { + "type": "number", + "description": "Valor do frete (optional)", + "format": "double" + }, + "valorFreteCliente": { + "type": "number", + "description": "Valor do frete cobrado do cliente", + "format": "double" + }, + "dataEntrega": { + "type": "string", + "description": "Data estimada da entrega do produto (optional)", + "format": "date" + }, + "informacoesAdicionais": { + "type": "array", + "description": "Informações adicionais do frete", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + } + }, + "type": "object" + } + }, + "pagamento": { + "type": "object", + "description": "Informações de pagamento do pedido", + "properties": { + "formaPagamentoId": { + "type": "integer", + "description": "Id da forma de pagamento", + "format": "int32" + }, + "numeroParcelas": { + "type": "integer", + "description": "Número parcelas", + "format": "int32" + }, + "valorParcela": { + "type": "number", + "description": "Valor da parcela", + "format": "double" + }, + "informacaoAdicional": { + "type": "array", + "description": "Informações adicionais de pagamento (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + } + } + }, + "canalId": { + "type": "integer", + "description": "ParceiroId vinculado ao pedido (optional)", + "format": "int32" + }, + "omniChannel": { + "type": "object", + "description": "Dados do pedido no marketplace (optional)", + "properties": { + "pedidoIdPublico": { + "type": "string", + "description": "Id do pedido que o cliente vê no momento que fecha a compra" + }, + "pedidoIdPrivado": { + "type": "string", + "description": "Id interno do marketplace" + }, + "integrador": { + "type": "object", + "description": "Dados do pedido no integrador", + "properties": { + "nome": { + "type": "string", + "description": "Nome do parceiro integrador" + }, + "pedidoId": { + "type": "string", + "description": "Numero do pedido dentro do integrador" + }, + "pedidoUrl": { + "type": "string", + "description": "Url do pedido dentro painel do integrador" + } + } + } + } + }, + "transacaoId": { + "type": "integer", + "description": "Id da transação (optional)", + "format": "int32" + }, + "observacao": { + "type": "string", + "description": "Observação do pedido (optional)" + }, + "valido": { + "type": "boolean", + "description": "Se um pedido é valido (optional)" + }, + "cupomDesconto": { + "type": "string", + "description": "Cupom de desconto (optional)" + }, + "ip": { + "type": "string", + "description": "IP da criação do pedido (optional)" + }, + "usuarioMaster": { + "type": "integer", + "description": "ID do usuário master que realizou o pedido, se houver (optional)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do pedido gerado": { + "value": "Id do pedido gerado" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb0a7b8210890054b5b7a9" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-portfolio.openapi.json b/wake/utils/openapi/insere-um-novo-portfolio.openapi.json new file mode 100644 index 000000000..ba8c84601 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-portfolio.openapi.json @@ -0,0 +1,106 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios": { + "post": { + "summary": "Insere um novo portfolio", + "description": "", + "operationId": "insere-um-novo-portfolio", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do portfolio" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do portfolio gerado": { + "value": "Id do portfolio gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bedcaaafb3b100e88d7fc5" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json b/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json new file mode 100644 index 000000000..732ddf078 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-produto-na-assinatura.openapi.json @@ -0,0 +1,155 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}/produtos": { + "post": { + "summary": "Insere um novo produto na assinatura", + "description": "", + "operationId": "insere-um-novo-produto-na-assinatura", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id de uma assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Produto Variante que será incluído na assinatura", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto que será inserido na assinatura", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Produto foi adicionado na assinatura": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a722139588e9027c7da95f" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-script.openapi.json b/wake/utils/openapi/insere-um-novo-script.openapi.json new file mode 100644 index 000000000..b3b9cff5a --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-script.openapi.json @@ -0,0 +1,194 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts": { + "post": { + "summary": "Insere um novo script", + "description": "", + "operationId": "insere-um-novo-script", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do script" + }, + "dataInicial": { + "type": "string", + "description": "Data inicial do script", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data final do script", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Informe se o script está ativo ou não" + }, + "prioridade": { + "type": "integer", + "description": "Prioridade do script", + "format": "int32" + }, + "posicao": { + "type": "string", + "description": "Posição do script", + "enum": [ + "HeaderPrimeiraLinha", + "HeaderUltimaLinha", + "BodyPrimeiraLinha", + "BodyUltimaLinha", + "FooterPrimeiraLinha", + "FooterUltimeLinha" + ] + }, + "tipoPagina": { + "type": "string", + "description": "Tipo da página do script", + "enum": [ + "Todas", + "Home", + "Busca", + "Categoria", + "Fabricante", + "Estaticas", + "Produto", + "Carrinho" + ] + }, + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b44f64c35c270014666e56" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json b/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json new file mode 100644 index 000000000..ad7bffef9 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-seller-no-marketplace.openapi.json @@ -0,0 +1,154 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers": { + "post": { + "summary": "Insere um novo Seller no marketplace", + "description": "", + "operationId": "insere-um-novo-seller-no-marketplace", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "razaoSocial": { + "type": "string", + "description": "Razão Social/Nome do Reseller" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do Seller" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição Estadual do Seller" + }, + "isento": { + "type": "boolean", + "description": "Seller isento de inscrição estadual" + }, + "email": { + "type": "string", + "description": "Email de contato do Seller" + }, + "telefone": { + "type": "string", + "description": "Telefone de contato do seller com ddd (xx) xxxx-xxxx" + }, + "tipoAutonomia": { + "type": "string", + "description": "Tipo de autonomia do vendedor", + "enum": [ + "ComAutonomia", + "SemAutonomia" + ] + }, + "ativo": { + "type": "boolean", + "description": "Seller Ativo" + }, + "split": { + "type": "boolean", + "description": "Se irá ter Split de frete boolean. Default:false" + }, + "buyBox": { + "type": "boolean", + "description": "Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false," + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "description": "Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false," + }, + "cep": { + "type": "string", + "description": "Cep do Seller (utilizado para o calculo de frete)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d1bf29766c65003571b218" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json b/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json new file mode 100644 index 000000000..f4c5fa6d5 --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-tipo-de-evento.openapi.json @@ -0,0 +1,191 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento": { + "post": { + "summary": "Insere um novo tipo de evento", + "description": "", + "operationId": "insere-um-novo-tipo-de-evento", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Tipo de Evento" + }, + "tipoEntrega": { + "type": "string", + "description": "Tipo de entrega", + "enum": [ + "EntregaAgendada", + "EntregaConformeCompraRealizada", + "Todos", + "Nenhum" + ] + }, + "tipoDisponibilizacao": { + "type": "string", + "description": "Disponibilização do Tipo de Evento", + "enum": [ + "DisponibilizacaoDeCreditos", + "DisponibilizacaoDeProdutos", + "Todos" + ] + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "description": "Permissão para remoção automática de produtos" + }, + "corHexTituloInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o titulo de informações" + }, + "corHexCorpoInformacoes": { + "type": "string", + "description": "Cor em hexadecimal para o corpo de informações" + }, + "numeroAbasInformacoes": { + "type": "integer", + "description": "Número de abas de informações, podendo ser de 1 a 2", + "format": "int32" + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "description": "Quantidade de dias para que o evento expire", + "format": "int32" + }, + "numeroLocaisEvento": { + "type": "integer", + "description": "Quantidade de locais do evento", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Informa se o evento está ativo ou inativo" + }, + "disponivel": { + "type": "boolean", + "description": "Informa a disponibilidade do evento" + }, + "tipoBeneficiarioFrete": { + "type": "string", + "description": "O beneficiário do frete", + "enum": [ + "DonodaLista", + "Convidado" + ] + }, + "imagemLogoEvento": { + "type": "string", + "description": "Imagem da logo do evento em base64" + }, + "sugestaoProdutos": { + "type": "array", + "description": "Produtos Sugeridos para este evento (optional)", + "items": { + "properties": { + "tipoEventoId": { + "type": "integer", + "description": "Id do tipo de evento", + "format": "int32" + }, + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62cedb444f456f02b7fbbc5e" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-novo-usuario.openapi.json b/wake/utils/openapi/insere-um-novo-usuario.openapi.json new file mode 100644 index 000000000..b0dc5e53a --- /dev/null +++ b/wake/utils/openapi/insere-um-novo-usuario.openapi.json @@ -0,0 +1,228 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios": { + "post": { + "summary": "Insere um novo usuário", + "description": "", + "operationId": "insere-um-novo-usuario", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tipoPessoa": { + "type": "string", + "description": "Tipo de pessoa", + "enum": [ + "Fisica", + "Juridica" + ] + }, + "origemContato": { + "type": "string", + "description": "Origem do contato", + "enum": [ + "Google", + "Bing", + "Jornal", + "PatrocinioEsportivo", + "RecomendacaoAlguem", + "Revista", + "SiteInternet", + "Televisao", + "Outro", + "UsuarioImportadoViaAdmin", + "PayPalExpress" + ] + }, + "tipoSexo": { + "type": "string", + "description": "Tipo Sexo (optional)", + "enum": [ + "Undefined", + "Masculino", + "Feminino" + ] + }, + "nome": { + "type": "string", + "description": "Nome do usuário (Max Length: 100)" + }, + "cpf": { + "type": "string", + "description": "CPF do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "email": { + "type": "string", + "description": "E-mail do usuário (Max Length: 100)" + }, + "rg": { + "type": "string", + "description": "RG do usuário caso seja pessoa física (Max Length: 50) (optional)" + }, + "telefoneResidencial": { + "type": "string", + "description": "Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50)" + }, + "telefoneCelular": { + "type": "string", + "description": "Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional)" + }, + "telefoneComercial": { + "type": "string", + "description": "Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional)" + }, + "dataNascimento": { + "type": "string", + "description": "Data de nascimento (optional)", + "format": "date" + }, + "razaoSocial": { + "type": "string", + "description": "Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional)" + }, + "cnpj": { + "type": "string", + "description": "CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "inscricaoEstadual": { + "type": "string", + "description": "Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional)" + }, + "responsavel": { + "type": "string", + "description": "Responsável(Max Length: 100) (optional)" + }, + "dataCriacao": { + "type": "string", + "description": "Data de criação do cadastro (optional)", + "format": "date" + }, + "dataAtualizacao": { + "type": "string", + "description": "Data de atualização do cadastro (optional)", + "format": "date" + }, + "revendedor": { + "type": "boolean", + "description": "Se o usuário é revendedor (optional)" + }, + "listaInformacaoCadastral": { + "type": "array", + "description": "Informação cadastral (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave" + }, + "valor": { + "type": "string", + "description": "Valor" + } + }, + "type": "object" + } + }, + "avatar": { + "type": "string", + "description": "Avatar (Max Length: 50) (optional)" + }, + "ip": { + "type": "string", + "description": "IP do usuário (Max Length: 20) (optional)" + }, + "aprovado": { + "type": "boolean", + "description": "Seta ou retorna o valor de Aprovado (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id do usuário gerado": { + "value": "Id do usuário gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d84176895f5d001468e6a4" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json b/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json new file mode 100644 index 000000000..28264aded --- /dev/null +++ b/wake/utils/openapi/insere-um-ou-mais-metatags-para-um-produto.openapi.json @@ -0,0 +1,180 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo/metaTag": { + "post": { + "summary": "Insere um ou mais metatags para um produto", + "description": "", + "operationId": "insere-um-ou-mais-metatags-para-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Identificador do produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "metas": { + "type": "array", + "description": "Lista de metatags (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"metatagId\": 0,\n \"content\": \"string\",\n \"httpEquiv\": \"string\",\n \"name\": \"string\",\n \"scheme\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "metatagId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "content": { + "type": "string", + "example": "string" + }, + "httpEquiv": { + "type": "string", + "example": "string" + }, + "name": { + "type": "string", + "example": "string" + }, + "scheme": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c5787bf8681e009e301a83" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json b/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json new file mode 100644 index 000000000..ff8a64fa8 --- /dev/null +++ b/wake/utils/openapi/insere-um-range-de-cep-em-uma-loja-fisica.openapi.json @@ -0,0 +1,157 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}/rangeCep": { + "post": { + "summary": "Insere um range de cep em uma Loja Física", + "description": "", + "operationId": "insere-um-range-de-cep-em-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do range de cep" + }, + "cepInicial": { + "type": "string", + "description": "Cep inicial do range. Formato: 00.000-000" + }, + "cepFinal": { + "type": "string", + "description": "Cep final do range. Formato: 00.000-000" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b9b945ae523a00681ad134" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json new file mode 100644 index 000000000..879e8f9a9 --- /dev/null +++ b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-pedido.openapi.json @@ -0,0 +1,188 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento": { + "post": { + "summary": "Insere um rastreamento e status a um pedido", + "description": "", + "operationId": "insere-um-rastreamento-e-status-a-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do Pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "dataEvento": { + "type": "string", + "description": "Data do pedido (optional)", + "format": "date" + }, + "numeroNotaFiscal": { + "type": "string", + "description": "Número da nota fiscal (optional)" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave acesso NFE (optional)" + }, + "urlNFE": { + "type": "string", + "description": "URL NFE (optional)" + }, + "serieNFE": { + "type": "string", + "description": "Serie NFE (optional)" + }, + "cfop": { + "type": "string", + "description": "CFOP (optional)" + }, + "urlRastreamento": { + "type": "string", + "description": "URL Rastreamento (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb11b77b19e300fd2d9070" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json new file mode 100644 index 000000000..e584357ae --- /dev/null +++ b/wake/utils/openapi/insere-um-rastreamento-e-status-a-um-produto-variante.openapi.json @@ -0,0 +1,204 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento": { + "post": { + "summary": "Insere um rastreamento e status a um produto variante", + "description": "", + "operationId": "insere-um-rastreamento-e-status-a-um-produto-variante", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do produto variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "description": "Id da situação do pedido", + "format": "int32" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade (optional)", + "format": "int32" + }, + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "rastreamento": { + "type": "string", + "description": "Rastreamento (optional)" + }, + "dataEvento": { + "type": "string", + "description": "Data (optional)", + "format": "date" + }, + "numeroNotaFiscal": { + "type": "string", + "description": "Número da nota fiscal (optional)" + }, + "chaveAcessoNFE": { + "type": "string", + "description": "Chave de acesso NFE (optional)" + }, + "urlNFE": { + "type": "string", + "description": "URL NFE (optional)" + }, + "serieNFE": { + "type": "string", + "description": "Serie NFE (optional)" + }, + "cfop": { + "type": "integer", + "description": "CFOP (optional)", + "format": "int32" + }, + "urlRastreamento": { + "type": "string", + "description": "URL de rastreamento (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bd8a130b1de500144fc9db" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json b/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json new file mode 100644 index 000000000..f22406160 --- /dev/null +++ b/wake/utils/openapi/insere-um-seo-para-um-produto-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/seo": { + "post": { + "summary": "Insere um SEO para um produto específico", + "description": "", + "operationId": "insere-um-seo-para-um-produto-especifico", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoId", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "tagCanonical": { + "type": "string", + "description": "Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional)" + }, + "title": { + "type": "string", + "description": "Informe o title da página do produto (optional)" + }, + "metaTags": { + "type": "array", + "description": "Informe os dados da Meta Tag (optional)", + "items": { + "properties": { + "content": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "httpEquiv": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "name": { + "type": "string", + "description": "Dados da Meta Tag" + }, + "scheme": { + "type": "string", + "description": "Dados da Meta Tag" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c49b1d38e2fb0031bb3c8d" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json b/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json new file mode 100644 index 000000000..a1b6fad23 --- /dev/null +++ b/wake/utils/openapi/insere-uma-avaliacao-para-um-produto-variante.openapi.json @@ -0,0 +1,192 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtoavaliacao/{identificador}": { + "post": { + "summary": "Insere uma avaliação para um produto variante", + "description": "", + "operationId": "insere-uma-avaliacao-para-um-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "comentario": { + "type": "string", + "description": "Texto referente a avaliação do produto" + }, + "avaliacao": { + "type": "integer", + "description": "Escala de 1 a 5 para avaliar o produto", + "format": "int32" + }, + "usuarioId": { + "type": "integer", + "description": "Identificado do usuário", + "format": "int32" + }, + "dataAvaliacao": { + "type": "string", + "description": "Referente a data que a avaliação foi criada", + "format": "date" + }, + "nome": { + "type": "string", + "description": "Nome do usuário que avaliou" + }, + "email": { + "type": "string", + "description": "Email do usuário que avaliou" + }, + "status": { + "type": "string", + "description": "Referente ao status que libera a visualização da avaliação no site", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d06c986bf8eb00583fef1d" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-inscricao.openapi.json b/wake/utils/openapi/insere-uma-inscricao.openapi.json new file mode 100644 index 000000000..01c312544 --- /dev/null +++ b/wake/utils/openapi/insere-uma-inscricao.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/webhook/inscricao": { + "post": { + "summary": "Insere uma inscrição", + "description": "", + "operationId": "insere-uma-inscricao", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "topicos" + ], + "properties": { + "nome": { + "type": "string", + "description": "Nome da inscrição" + }, + "appUrl": { + "type": "string", + "description": "Url para qual deve ser enviada as notificações" + }, + "topicos": { + "type": "array", + "description": "Tópicos em que deseja se inscrever", + "items": { + "type": "string" + } + }, + "usuario": { + "type": "string", + "description": "Usuário que está realizando a inscrição" + }, + "ativo": { + "type": "boolean", + "description": "Status da inscrição, se ativada ou desativada" + }, + "emailResponsavel": { + "type": "string", + "description": "E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado" + }, + "headers": { + "type": "array", + "description": "Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional)", + "items": { + "properties": { + "chave": { + "type": "string", + "description": "Chave do header, por exemplo: 'Authorization'" + }, + "valor": { + "type": "string", + "description": "Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD'" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb51dbfe13b702bcabb9e0" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-loja-fisica.openapi.json b/wake/utils/openapi/insere-uma-loja-fisica.openapi.json new file mode 100644 index 000000000..e296fe2e0 --- /dev/null +++ b/wake/utils/openapi/insere-uma-loja-fisica.openapi.json @@ -0,0 +1,239 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas": { + "post": { + "summary": "Insere uma Loja Física", + "description": "", + "operationId": "insere-uma-loja-fisica", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "description": "Id da loja (optional)", + "format": "int32" + }, + "nome": { + "type": "string", + "description": "Nome da loja (optional)" + }, + "ddd": { + "type": "integer", + "description": "DDD da localidade de destino da loja (optional)", + "format": "int32" + }, + "telefone": { + "type": "string", + "description": "Telefone da loja (optional)" + }, + "email": { + "type": "string", + "description": "E-mail de contato da loja (optional)" + }, + "cep": { + "type": "string", + "description": "CEP do endereço da loja (optional)" + }, + "logradouro": { + "type": "string", + "description": "Logradouro do endereço da loja (optional)" + }, + "numero": { + "type": "string", + "description": "Número de localização do endereço da loja (optional)" + }, + "complemento": { + "type": "string", + "description": "Complemento para localização da loja (optional)" + }, + "bairro": { + "type": "string", + "description": "Bairro do endereço do loja (optional)" + }, + "cidade": { + "type": "string", + "description": "Cidade em que a loja se encontra (optional)" + }, + "estadoId": { + "type": "integer", + "description": "Id do estado em que a loja se encontra (optional)", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega (optional)", + "format": "int32" + }, + "prazoMaximoRetirada": { + "type": "integer", + "description": "Prazo máximo para retirada (optional)", + "format": "int32" + }, + "ativo": { + "type": "boolean", + "description": "Status da loja (optional)" + }, + "valido": { + "type": "boolean", + "description": "Valido (optional)" + }, + "textoComplementar": { + "type": "string", + "description": "Informações complementares da loja (optional)" + }, + "retirarNaLoja": { + "type": "boolean", + "description": "Se a retirada na loja será ativada (optional)" + }, + "latitude": { + "type": "number", + "description": "Latitude (optional)", + "format": "double" + }, + "longitude": { + "type": "number", + "description": "Longitude (optional)", + "format": "double" + }, + "centroDistribuicao": { + "type": "array", + "description": "Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional)", + "items": { + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "description": "Id do centro de distribuição", + "format": "int32" + }, + "prazoEntrega": { + "type": "integer", + "description": "Prazo de entrega", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5f0cf26899305a6f7ea96" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-nova-categoria.openapi.json b/wake/utils/openapi/insere-uma-nova-categoria.openapi.json new file mode 100644 index 000000000..735beadad --- /dev/null +++ b/wake/utils/openapi/insere-uma-nova-categoria.openapi.json @@ -0,0 +1,177 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias": { + "post": { + "summary": "Insere uma nova categoria", + "description": "", + "operationId": "insere-uma-nova-categoria", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da categoria (optional)" + }, + "categoriaPaiId": { + "type": "integer", + "description": "Id da categoria pai (optional)", + "format": "int32" + }, + "categoriaERPId": { + "type": "string", + "description": "Id da categoria ERP (optional)" + }, + "ativo": { + "type": "boolean", + "description": "Categoria ativo/inativo (optional)" + }, + "isReseller": { + "type": "boolean", + "description": "Categoria de reseller (optional)" + }, + "exibirMatrizAtributos": { + "type": "string", + "description": "Exibir Matriz de Atributos (optional)", + "enum": [ + "Sim", + "Nao", + "Neutro" + ] + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "description": "Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional)", + "format": "int32" + }, + "valorMinimoCompra": { + "type": "number", + "description": "Informe o valor mínimo para compra em produtos desta categoria (optional)", + "format": "double" + }, + "exibeMenu": { + "type": "boolean", + "description": "Informe se será exibida no menu (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da categoria gerada": { + "value": "\tId da categoria gerada" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a9e9ff320058003cb2c812" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json b/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json new file mode 100644 index 000000000..1ccb7e22b --- /dev/null +++ b/wake/utils/openapi/insere-uma-nova-tabela-de-precos.openapi.json @@ -0,0 +1,120 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos": { + "post": { + "summary": "Insere uma nova tabela de preços", + "description": "", + "operationId": "insere-uma-nova-tabela-de-precos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome da tabela de preço" + }, + "dataInicial": { + "type": "string", + "description": "Data que inicia a tabela de preço", + "format": "date" + }, + "dataFinal": { + "type": "string", + "description": "Data de término da tabela de preço", + "format": "date" + }, + "ativo": { + "type": "boolean", + "description": "Status da tabela de preço" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da tabela de preços gerado": { + "value": "Id da tabela de preços gerado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a74857fb2e00a66e7ab3" +} \ No newline at end of file diff --git a/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json b/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json new file mode 100644 index 000000000..a469799ea --- /dev/null +++ b/wake/utils/openapi/insere-uma-versao-para-um-script-existente.openapi.json @@ -0,0 +1,157 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/gestorscripts/scripts/{scriptId}/versoes": { + "post": { + "summary": "Insere uma versão para um script existente", + "description": "", + "operationId": "insere-uma-versao-para-um-script-existente", + "parameters": [ + { + "name": "scriptId", + "in": "path", + "description": "Id do script", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "identificadorPagina": { + "type": "string", + "description": "Identificador da página" + }, + "conteudo": { + "type": "string", + "description": "Conteúdo do script" + }, + "publicado": { + "type": "boolean", + "description": "Status do script" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b46898ef4727006dee2c10" +} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..92671a6bd --- /dev/null +++ b/wake/utils/openapi/inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos.openapi.json @@ -0,0 +1,187 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}/produtos": { + "post": { + "summary": "Inseri uma lista de produto variantes em uma tabela de preços", + "description": "", + "operationId": "inseri-uma-lista-de-produto-variantes-em-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de produtos variantes", + "items": { + "properties": { + "sku": { + "type": "string", + "description": "SKU do produto" + }, + "precoDe": { + "type": "number", + "description": "Preço De do produto", + "format": "double" + }, + "precoPor": { + "type": "number", + "description": "Preço Por do produto", + "format": "double" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Lista com o retorno do processamento dos produtos enviados": { + "value": "{\n \"sucesso\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ],\n \"erro\": [\n {\n \"sku\": \"string\",\n \"resultado\": true,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sucesso": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "erro": { + "type": "array", + "items": { + "type": "object", + "properties": { + "sku": { + "type": "string", + "example": "string" + }, + "resultado": { + "type": "boolean", + "example": true, + "default": true + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a9fe4960ff007e2e25d5" +} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json new file mode 100644 index 000000000..010e2b271 --- /dev/null +++ b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido-1.openapi.json @@ -0,0 +1,166 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/observacao": { + "post": { + "summary": "Insere uma observação a um pedido", + "description": "", + "operationId": "inseri-uma-observacao-a-um-pedido-1", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Objeto com os dados da observação (optional)", + "properties": { + "observacao": { + "type": "string", + "description": "Texto da observação" + }, + "usuario": { + "type": "string", + "description": "Nome do usuário que está inserindo a observação" + }, + "publica": { + "type": "boolean", + "description": "Se a observação é publica ou privada" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb3bc41fe5a9003e92271a" +} \ No newline at end of file diff --git a/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json new file mode 100644 index 000000000..9c4e48545 --- /dev/null +++ b/wake/utils/openapi/inseri-uma-observacao-a-um-pedido.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/observacao": { + "get": { + "summary": "Retorna a observação de um pedido", + "description": "Lista de observações de um pedido", + "operationId": "inseri-uma-observacao-a-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"publica\": true,\n \"data\": \"2022-06-28T11:18:19.263Z\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.263Z" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb3a3b0a861a04b9dd482b" +} \ No newline at end of file diff --git a/wake/utils/openapi/inserir-autor.openapi.json b/wake/utils/openapi/inserir-autor.openapi.json new file mode 100644 index 000000000..4c4fcda8a --- /dev/null +++ b/wake/utils/openapi/inserir-autor.openapi.json @@ -0,0 +1,141 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autores": { + "post": { + "summary": "Inserir autor", + "description": "", + "operationId": "inserir-autor", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "description": "Nome do Autor" + }, + "ativo": { + "type": "boolean", + "description": "Status do autor" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0fedceb452400b2cca404" +} \ No newline at end of file diff --git a/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json b/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json new file mode 100644 index 000000000..29787fc65 --- /dev/null +++ b/wake/utils/openapi/liberar-reservas-de-pedidos.openapi.json @@ -0,0 +1,144 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/liberarReservas": { + "post": { + "summary": "Liberar reservas de pedidos", + "description": "", + "operationId": "liberar-reservas-de-pedidos", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Números dos pedidos que se deseja buscar", + "items": { + "type": "integer", + "format": "int64" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb3420b31f30003d9e5990" +} \ No newline at end of file diff --git a/wake/utils/openapi/openapi.gen.ts b/wake/utils/openapi/openapi.gen.ts new file mode 100644 index 000000000..635c7d1c6 --- /dev/null +++ b/wake/utils/openapi/openapi.gen.ts @@ -0,0 +1,9386 @@ +// DO NOT EDIT. This file is generated by deco. +// This file SHOULD be checked into source version control. +// To generate this file: deno run -A scripts/openAPI.ts + +export interface API { + /** @description Últimos Pedidos */ + "GET /dashboard/pedidos": { + response: { + pedidoId?: number; + situacaoPedidoId?: number; + situacaoNome?: string; + data?: string; + dataFormatado?: string; + hora?: string; + valorTotal?: string; + }[]; + }; + /** @description Atualiza a exibição do banner nos hotsites, se deve ser em todos ou não */ + "PUT /banners/:bannerId/hotsites": { + body: { + /** + * Exibição do banner nos hotsites + */ + exibirEmTodosHotsites?: boolean; + }; + }; + /** @description Retorna se o usuário ativou o recebimento de newsletter */ + "GET /usuarios/:email/comunicacao": { + response: { + recebimentoNewsletter?: boolean; + }; + }; + /** @description Atualizar autor */ + "PUT /autores/:autorId": { + body: { + /** + * Nome do Autor + */ + nome?: string; + /** + * Status do autor + */ + ativo?: boolean; + }; + }; + /** @description Retorna lista contendo os Id's dos pedidos do usuário */ + "GET /usuarios/:email/pedidos": { + response: { + pedidoId?: number; + links?: { + href?: string; + rel?: string; + method?: string; + }[]; + }[]; + }; + /** @description Usuário encontrado */ + "GET /usuarios/cpf/:cpf": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** @description Loja Física */ + "GET /lojasFisicas/:lojaFisicaId": { + response: { + lojaId?: number; + nome?: string; + ddd?: number; + telefone?: string; + email?: string; + cep?: string; + logradouro?: string; + numero?: string; + complemento?: string; + bairro?: string; + cidade?: string; + estadoId?: number; + prazoEntrega?: number; + prazoMaximoRetirada?: number; + ativo?: boolean; + valido?: boolean; + textoComplementar?: string; + retirarNaLoja?: boolean; + latitude?: number; + longitude?: number; + centroDistribuicaoId?: number; + centroDistribuicao?: { + centroDistribuicaoId?: number; + prazoEntrega?: number; + }[]; + }; + }; + /** @description Atributo encontrado */ + "GET /atributos/:nome": { + response: { + nome?: string; + tipo?: string; + tipoExibicao?: string; + prioridade?: number; + }; + }; + /** @description Lista de resellers */ + "GET /resellers": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }[]; + }; + /** @description Reseller específico */ + "GET /resellers/:resellerId": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + }; + /** @description Método que insere um produto na base */ + "POST /produtos": { + body: { + /** + * Representa o ProdutoId agrupador por variante (optional) + */ + idPaiExterno?: string; + /** + * Representa o ParentId agrupador por parent (optional) + */ + idVinculoExterno?: string; + /** + * (Max Length: 50) Sku do produto + */ + sku?: string; + /** + * (Max Length: 300) Nome do produto variante + */ + nome?: string; + /** + * Nome do produto (pai do variante) (optional) + */ + nomeProdutoPai?: string; + /** + * Tipo de exibição da matriz de atributos (optional) + */ + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + /** + * Se o produto aceita contra proposta (optional) + */ + contraProposta?: boolean; + /** + * (Max Length: 100) Nome do fabricante + */ + fabricante?: string; + /** + * (Max Length: 500) Nome do autor (optional) + */ + autor?: string; + /** + * (Max Length: 100) Nome da editora (optional) + */ + editora?: string; + /** + * (Max Length: 100) Nome da coleção (optional) + */ + colecao?: string; + /** + * (Max Length: 100) Nome do gênero (optional) + */ + genero?: string; + /** + * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) + */ + precoCusto?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) + */ + precoDe?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante + */ + precoPor?: number; + /** + * (Max Length: 8, "0000.0000,00") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) + */ + fatorMultiplicadorPreco?: number; + /** + * Prazo de entrega do produto variante (optional) + */ + prazoEntrega?: number; + /** + * Define se um produto variante é valido ou não + */ + valido?: boolean; + /** + * Define se um produto deve ser exibido no site + */ + exibirSite?: boolean; + /** + * Define a qual regra de calculo de frete o produto vai pertencer + */ + freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; + /** + * Define se o produto variante tem troca grátis (optional) + */ + trocaGratis?: boolean; + /** + * (Max Length: 8, "0000.0000,00") Peso do produto variante, em gramas (g). + */ + peso?: number; + /** + * (Max Length: 8, "0000.0000,00") Altura do produto variante, em centímetros (cm). + */ + altura?: number; + /** + * (Max Length: 8, "0000.0000,00") Comprimento do produto variante, em centímetros (cm). + */ + comprimento?: number; + /** + * (Max Length: 8, "0000.0000,00") Largura do produto variante, em centímetros (cm). + */ + largura?: number; + /** + * Define se o produto variante tem garantia (optional) + */ + garantia?: number; + /** + * Define se o produto contém televendas (optional) + */ + isTelevendas?: boolean; + /** + * (Max Length: 25) EAN do produto variante (optional) + */ + ean?: string; + /** + * (Max Length: 255) Localização no estoque do produto variante (optional) + */ + localizacaoEstoque?: string; + /** + * Dados de atacado do produto variante (optional) + */ + listaAtacado?: { + /** + * (Max Length: 8, "0000.0000,00") - Preco Por do item por atacado + */ + precoPor?: number; + /** + * Quantidade para compra de atacado + */ + quantidade?: number; + }[]; + /** + * Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional) + */ + estoque?: { + /** + * Estoque físico do produto + */ + estoqueFisico?: number; + /** + * Estoque reservado do produto + */ + estoqueReservado?: number; + /** + * Id do centro de distribuição do estoque do produto + */ + centroDistribuicaoId?: number; + /** + * Quantidade para ativar o alerta de estoque + */ + alertaEstoque?: number; + }[]; + /** + * Lista de atributos do produto + */ + listaAtributos?: { + /** + * (Max Length: 100) - Define o nome do atributo + */ + nome?: string; + /** + * (Max Length: 8, "0000.0000,00") - Define o valor do atributo + */ + valor?: string; + /** + * Define se o atributo deverá ser exibido + */ + exibir?: boolean; + }[]; + /** + * Quantidade máxima de compra do produto variante (optional) + */ + quantidadeMaximaCompraUnidade?: number; + /** + * Quantidade mínima de compra do produto variante (optional) + */ + quantidadeMinimaCompraUnidade?: number; + /** + * Condição do produto variante (optional) + */ + condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; + /** + * Url do vídeo do Produto (optional) + */ + urlVideo?: string; + /** + * Se o produto aparece no Spot (optional) + */ + spot?: boolean; + /** + * Se o produto aparece na Url (optional) + */ + paginaProduto?: boolean; + /** + * Se o produto aparece no Marketplace (optional) + */ + marketplace?: boolean; + /** + * Se o produto aparece somente nos Parceiros (optional) + */ + somenteParceiros?: boolean; + /** + * Se o produto deve ser agrupado pelo EAN (optional) + */ + buyBox?: boolean; + /** + * Prazo de validade ou consumo do produto (optional) + */ + prazoValidade?: number; + /** + * Dados de consumo de produto e se deve enviar os dias de consumo por e-mail. + */ + consumo?: { + /** + * Quantidade de Dias (optional) + */ + quantidadeDias?: number; + /** + * Enviar e-mail (optional) + */ + enviarEmail?: boolean; + }; + }; + }; + /** @description Remove um produto de uma tabela de preço */ + "DELETE /tabelaPrecos/:tabelaPrecoId/:sku": {}; + /** @description Atualiza o frete de todos os produtos de um pedido */ + "PUT /pedidos/:pedidoId/changeseller": { + body: { + /** + * Objeto com os dados de cotação e responsável + */ + RAW_BODY: { + /** + * ID da cotação retornada em GET /fretes/pedidos/{pedidoId}/cotacoes + */ + cotacao?: string; + /** + * Responsável pela cotação + */ + responsavel?: string; + }; + }; + }; + /** @description Objeto do banner */ + "GET /banners/:bannerId": { + response: { + id?: number; + nome?: string; + dataInicio?: string; + dataFim?: string; + ativo?: boolean; + detalhe?: { + posicionamentoId?: number; + urlBanner?: string; + imagemBanner?: { + nome?: string; + base64?: string; + formato?: string; + }; + ordemExibicao?: number; + abrirBannerNovaAba?: boolean; + largura?: number; + altura?: number; + title?: string; + urlClique?: string; + urlBannerAlternativo?: string; + titleAlternativo?: string; + diasExibicao?: { + todosDias?: boolean; + domingo?: boolean; + segunda?: boolean; + terca?: boolean; + quarta?: boolean; + quinta?: boolean; + sexta?: boolean; + sabado?: boolean; + }; + textoAlternativo?: string; + }; + apresentacao?: { + exibirNoSite?: boolean; + exibirEmTodasBuscas?: boolean; + naoExibirEmBuscas?: boolean; + termosBusca?: string; + listaHotsites?: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + exibirEmTodasCategorias?: boolean; + listaParceiros?: { + exibirEmTodosParceiros?: boolean; + parceiros?: { + parceiroId?: number; + }[]; + }; + }; + }; + }; + /** @description Atualiza um produto em uma assinatura */ + "PUT /assinaturas/produtos/:assinaturaProdutoId/Alterar": { + body: { + /** + * Novo valor do produto na assinatura (optional) + */ + valor?: number; + /** + * Se o produto será considerado removido ou não da assinatura (optional) + */ + removido?: boolean; + /** + * Quantidade do produto na assinatura (optional) + */ + quantidade?: number; + }; + }; + /** @description Parceiro encontrado */ + "GET /parceiros/:parceiroId": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }; + }; + /** @description Lista de parceiros */ + "GET /parceiros": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }[]; + }; + /** @description Deleta um banner existente */ + "DELETE /banners/:bannerId": {}; + /** @description Insere um novo tipo de evento */ + "POST /tiposEvento": { + body: { + /** + * Nome do Tipo de Evento + */ + nome?: string; + /** + * Tipo de entrega + */ + tipoEntrega?: + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; + /** + * Disponibilização do Tipo de Evento + */ + tipoDisponibilizacao?: + | "DisponibilizacaoDeCreditos" + | "DisponibilizacaoDeProdutos" + | "Todos"; + /** + * Permissão para remoção automática de produtos + */ + permitirRemocaoAutomaticaProdutos?: boolean; + /** + * Cor em hexadecimal para o titulo de informações + */ + corHexTituloInformacoes?: string; + /** + * Cor em hexadecimal para o corpo de informações + */ + corHexCorpoInformacoes?: string; + /** + * Número de abas de informações, podendo ser de 1 a 2 + */ + numeroAbasInformacoes?: number; + /** + * Quantidade de dias para que o evento expire + */ + quantidadeDiasParaEventoExpirar?: number; + /** + * Quantidade de locais do evento + */ + numeroLocaisEvento?: number; + /** + * Informa se o evento está ativo ou inativo + */ + ativo?: boolean; + /** + * Informa a disponibilidade do evento + */ + disponivel?: boolean; + /** + * O beneficiário do frete + */ + tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; + /** + * Imagem da logo do evento em base64 + */ + imagemLogoEvento?: string; + /** + * Produtos Sugeridos para este evento (optional) + */ + sugestaoProdutos?: { + /** + * Id do tipo de evento + */ + tipoEventoId?: number; + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Lista de preços e estoque de produtos que sofreram alterações */ + "GET /produtos/alteracoes": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + */ + alteradosPartirDe?: string; + }; + response: { + produtoId?: number; + produtoVarianteId?: number; + sku?: string; + precoDe?: number; + precoPor?: number; + disponivel?: boolean; + valido?: boolean; + exibirSite?: boolean; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + }[]; + }; + /** @description Retorna a situação reseller de um produto */ + "GET /produtos/:identificador/situacaoReseller": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Buscar autor por id */ + "GET /autores/:autorId": {}; + /** @description Lista de atributos */ + "GET /atributos": { + response: { + nome?: string; + tipo?: string; + tipoExibicao?: string; + prioridade?: number; + }[]; + }; + /** @description Inscrição */ + "GET /webhook/inscricao/:inscricaoId": { + response: { + inscricaoId?: number; + nome?: string; + appUrl?: string; + ativo?: boolean; + emailResponsavel?: string; + topico?: string[]; + usuario?: string; + header?: { + headerId?: number; + chave?: string; + valor?: string; + }[]; + }; + }; + /** @description Insere um novo produto na assinatura */ + "POST /assinaturas/:assinaturaId/produtos": { + body: { + /** + * Produto Variante que será incluído na assinatura + */ + produtoVarianteId?: number; + /** + * Quantidade do produto que será inserido na assinatura + */ + quantidade?: number; + }; + }; + /** @description Atualiza uma categoria */ + "PUT /categorias/:id": { + body: { + /** + * Nome da categoria (optional) + */ + nome?: string; + /** + * Id da categoria pai (optional) + */ + categoriaPaiId?: number; + /** + * Id da categoria ERP (optional) + */ + categoriaERPId?: string; + /** + * Categoria ativo/inativo (optional) + */ + ativo?: boolean; + /** + * Categoria de reseller (optional) + */ + isReseller?: boolean; + /** + * Exibir Matriz de Atributos (optional) + */ + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + /** + * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) + */ + quantidadeMaximaCompraUnidade?: number; + /** + * Informe o valor mínimo para compra em produtos desta categoria (optional) + */ + valorMinimoCompra?: number; + /** + * Informe se será exibida no menu (optional) + */ + exibeMenu?: boolean; + }; + }; + /** @description Deletar autor */ + "DELETE /autores/:autorId": {}; + /** @description Retorna todos os identificadores dos produtos/variantes relacionados ao produto pesquisado */ + "GET /produtos/:identificador/relacionados": { + searchParams: { + /** + * Define se o identificador informado é um Sku, um ProdutoId (Agrupador de variantes) ou um ProdutoVarianteId + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + response: { + produtoId?: number; + parentId?: number; + produtoVarianteId?: number; + sku?: string; + }[]; + }; + /** @description Atualiza um valor pré definido pelo id */ + "PUT /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": + { + body: { + /** + * Valor para o campo (optional) + */ + valor?: string; + /** + * Ordem (optional) + */ + ordem?: number; + }; + }; + /** @description Insere um novo banner */ + "POST /banners": { + body: { + /** + * Nome do banner + */ + nome?: string; + /** + * Data de inicio de exibição do banner + */ + dataInicio?: string; + /** + * Data de termino de exibição do banner (optional) + */ + dataFim?: string; + /** + * Banner ativo/inativo (optional) + */ + ativo?: boolean; + /** + * Detalhes do banner + */ + detalhe?: { + /** + * Local de posicionamento do banner + */ + posicionamentoId?: number; + /** + * Imagem do banner (caso o campo "UrlBanner" estiver preenchido esse campo será desconsiderado) (optional) + */ + imagemBanner?: { + /** + * string da imagem em base 64 + */ + base64?: string; + /** + * formato da imagem + */ + formato?: "PNG" | "JPG" | "JPEG"; + /** + * nome da imagem + */ + nome?: string; + }; + /** + * Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional) + */ + urlBanner?: string; + /** + * Ordem de exibição do banner (optional) + */ + ordemExibicao?: number; + /** + * Se o banner deve ou não abrir em nova aba (optional) + */ + abrirLinkNovaAba?: boolean; + /** + * Largura do banner em pixels (optional) + */ + largura?: number; + /** + * Altura do banner em pixels (optional) + */ + altura?: number; + /** + * Title da imagem do banner (optional) + */ + title?: string; + /** + * Url de destino para quando o usuário clicar no Banner (optional) + */ + urlClique?: string; + /** + * URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional) + */ + urlBannerAlternativo?: string; + /** + * Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner + */ + textoAlternativo?: string; + }; + /** + * Dias da semana que o banner deverá ser exibido (optional) + */ + diasExibicao?: { + /** + * Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como "true" os demais serão desconsiderados) + */ + todosDias?: boolean; + /** + * Se o banner deverá ser apresentado no domingo + */ + domingo?: boolean; + /** + * Se o banner deverá ser apresentado na segunda + */ + segunda?: boolean; + /** + * Se o banner deverá ser apresentado na terça + */ + terca?: boolean; + /** + * Se o banner deverá ser apresentado na quarta + */ + quarta?: boolean; + /** + * Se o banner deverá ser apresentado na quinta + */ + quinta?: boolean; + /** + * Se o banner deverá ser apresentado na sexta + */ + sexta?: boolean; + /** + * Se o banner deverá ser apresentado no sábado + */ + sabado?: boolean; + }; + /** + * Detalhes de apresentação do banner (optional) + */ + apresentacao?: { + /** + * Se o banner deverá ser exibido em todo o site + */ + exibirNoSite?: boolean; + /** + * Se o banner deverá ser exibido em todas as buscas + */ + exibirEmTodasBuscas?: boolean; + /** + * Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ + naoExibirEmBuscas?: boolean; + /** + * Termos que o banner será exibido na busca + */ + termosBusca?: string; + /** + * Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ + exibirEmTodasCategorias?: boolean; + /** + * Em quais hotsites o banner deve ser exibido + */ + listaHotsites?: { + /** + * Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como "true" o campo HotSites será desconsiderado) (optional) + */ + exibirEmTodosHotsites?: boolean; + /** + * Lista de hotsite's que o banner será exibido + */ + hotsites?: { + /** + * Id do hotsite (optional) + */ + hotSiteId?: number; + }[]; + }; + }; + /** + * Em quais parceiros o banner deve ser exibido + */ + listaParceiros?: { + /** + * Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) (optional) + */ + exibirEmTodosParceiros?: boolean; + /** + * Lista de parceiros que o banner será exibido + */ + parceiros?: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + }[]; + }; + }; + }; + /** @description Deleta um avatar de um usuário */ + "DELETE /usuarios/:email/avatar": {}; + /** @description Atualiza uma inscrição */ + "PUT /webhook/inscricao/:inscricaoId": { + body: { + /** + * Nome da inscrição + */ + nome?: string; + /** + * Url para qual deve ser enviada as notificações + */ + appUrl?: string; + /** + * Tópicos em que deseja se inscrever + */ + topicos: string[]; + /** + * Usuário que está realizando a inscrição + */ + usuario?: string; + /** + * Status da inscrição, se ativada ou desativada + */ + ativo?: boolean; + /** + * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado + */ + emailResponsavel?: string; + /** + * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) + */ + headers?: { + /** + * Chave do header, por exemplo: 'Authorization' + */ + chave?: string; + /** + * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' + */ + valor?: string; + }[]; + }; + }; + /** @description Exclui um fabricante */ + "DELETE /fabricantes/:fabricanteId": {}; + /** @description Lista de posicionamentos do banner */ + "GET /banners/posicionamentos": { + response: { + posicionamentoId?: number; + descricao?: string; + }[]; + }; + /** @description Insere um novo avatar para o usuário */ + "POST /usuarios/:email/avatar": { + body: { + /** + * Imagem do avatar em base64 (optional) + */ + base64?: string; + /** + * Formato da imagem (optional) + */ + formato?: string; + }; + response: { + urlAvatar?: string; + }; + }; + /** @description Preços do produto variante informado */ + "GET /produtos/:identificador/precos": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteId?: number; + sku?: string; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + precosTabelaPreco?: { + produtoVarianteId?: number; + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + }; + }; + /** @description Atualiza a autonomia de um Seller */ + "PUT /resellers/:resellerId/autonomia": { + body: { + /** + * Status da autonomia do seller + */ + ativo?: boolean; + }; + }; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos/:eventoId/produtos": { + response: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + }; + /** @description Atualiza o status do hotsite, sendo ativo (true) ou inativo (false) */ + "PUT /hotsites/:hotsiteId/status": { + body: { + /** + * Status para qual o hotsite indicado deve ir + */ + ativo?: boolean; + }; + }; + /** @description Autenticação realizada com sucesso */ + "POST /autenticacao/login": { + body: { + /** + * Login do usuário (optional) + */ + login?: string; + /** + * Senha do usuário (optional) + */ + senha?: string; + }; + }; + /** @description Parceiro encontrado */ + "GET /parceiros/:nome": { + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }; + }; + /** @description Seta status do produto variante como ativo ou inativo */ + "PUT /produtos/:identificador/situacao": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Define se o produto variante informado será ativo ou inativo + */ + status?: boolean; + }; + }; + /** @description Lista de Grupos de Personalização */ + "GET /grupospersonalizacao": { + response: { + grupoPersonalizacaoId?: number; + nome?: string; + ativo?: boolean; + obrigatorio?: boolean; + }[]; + }; + /** @description Retorna o saldo de um usuário */ + "GET /contascorrentes/:email": {}; + /** @description Lista de produtos */ + "GET /resellers/produtos/:identificador": { + searchParams: { + /** + * Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller + */ + tipoIdentificador?: "ResellerId" | "RazaoSocial"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Se deve retornar apenas produtos válidos (padrão: false) + */ + somenteValidos?: boolean; + /** + * Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo + */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + }[]; + }; + /** @description Lista de pedidos */ + "GET /pedidos/formaPagamento/:formasPagamento": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + situacoesPedido?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** @description Caso a loja utilize as formas de pagamento do gateway o campo "formaPagamentoId" do objeto "pagamento" deverá conter o valor "200". */ + "POST /pedidos": { + body: { + /** + * Id do pedido que está sendo inserido. Caso seja informado deve ser um Id disponível na loja. Caso não seja informado um Id será gerado (optional) + */ + pedidoId?: number; + /** + * Id do carrinho que foi utilizado no pedido (optional) + */ + carrinhoId?: string; + /** + * Define em qual situação está o pedido. A lista completa das possíveis situações se encontra no GET /situacoesPedido + */ + situacaoPedidoId?: number; + /** + * Data em que o pedido foi realizado + */ + data?: string; + /** + * Valor total do pedido. Se informado deve ser igual a soma de todos os valores inclusos no pedido (preços dos produtos, ajustes, frete, etc) (optional) + */ + valorTotal?: number; + /** + * Informação do juros do pedido + */ + valorJuros?: number; + /** + * Informação de desconto do pedido + */ + valorDesconto?: number; + /** + * Id do usuário que realizou a compra. É possível recuperar o Id de um usuário no GET /usuarios + */ + usuarioId?: number; + /** + * Id do endereço do usuário que deve ser utilizado como endereço de entrega. Para buscar os endereços de um usuário utilize o GET /usuarios/{usuarioId}/enderecos + */ + enderecoId?: number; + /** + * Define se o pedido foi feito através de um dispositivo móvel ou não + */ + isMobile?: boolean; + /** + * Id do evento ao qual o pedido está vinculado (opcional) + */ + eventoId?: number; + /** + * Lista contendo os produtos do pedido + */ + produtos?: { + /** + * Id do produto variante que está vinculado a esse pedido. + */ + produtoVarianteId?: number; + /** + * Define a quantidade do produto, podendo ser dividida por diferentes centros de distribuição + */ + quantidade?: { + /** + * Quantidade por centro de distribuição + */ + quantidadeTotal?: number; + /** + * Quantidade (optional) + */ + quantidadePorCentroDeDistribuicao?: { + /** + * Id do centro de distribuição + */ + centroDistribuicaoId?: number; + /** + * Quantidade + */ + quantidade?: number; + }[]; + }; + /** + * Preço de venda do produto, sem adição ou subtração de valores. + */ + precoVenda?: number; + /** + * Define se esse produto é um brinde ou não + */ + isBrinde?: boolean; + /** + * Lista contendo todos os ajustes de preço do produto + */ + ajustes?: { + /** + * Define o tipo do ajuste de valor de um produto contido em um pedido. = ['Frete', 'Pricing', 'Atacarejo', 'Personalizacao', 'Embalagem', 'Promocao', 'PromocaoFrete', 'ContaCorrente', 'FormaPagamento', 'PromocaoProduto', 'TipoFreteProduto', 'Formula']stringEnum:"Frete", "Pricing", "Atacarejo", "Personalizacao", "Embalagem", "Promocao", "PromocaoFrete", "ContaCorrente", "FormaPagamento", "PromocaoProduto", "TipoFreteProduto", "Formula" + */ + tipo?: string; + /** + * Define o valor do ajuste a ser aplicado no produto. O valor pode ser positivo ou negativo + */ + valor?: number; + /** + * Observação (optional) + */ + observacao?: string; + /** + * Nome (optional) + */ + nome?: string; + }[]; + }[]; + /** + * Informações de frete do pedido + */ + fretes?: { + /** + * Identificador do centro de distribuição de origem + */ + centroDistribuicaoId?: number; + /** + * Identificador do contrato de frete (optional) + */ + freteContratoId?: number; + /** + * Peso em gramas (g) do frete calculado (optional) + */ + peso?: number; + /** + * Peso em gramas cobrado do cliente (optional) + */ + pesoCobrado?: number; + /** + * Volume em metro cúbico (m³) calculado (optional) + */ + volume?: number; + /** + * Volume em metro cúbico (m³) cobrado do cliente (optional) + */ + volumeCobrado?: number; + /** + * Prazo do envio do frete em dias úteis + */ + prazoEnvio?: number; + /** + * Valor do frete (optional) + */ + valorFreteEmpresa?: number; + /** + * Valor do frete cobrado do cliente + */ + valorFreteCliente?: number; + /** + * Data estimada da entrega do produto (optional) + */ + dataEntrega?: string; + /** + * Informações adicionais do frete + */ + informacoesAdicionais?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; + }[]; + /** + * Informações de pagamento do pedido + */ + pagamento?: { + /** + * Id da forma de pagamento + */ + formaPagamentoId?: number; + /** + * Número parcelas + */ + numeroParcelas?: number; + /** + * Valor da parcela + */ + valorParcela?: number; + /** + * Informações adicionais de pagamento (optional) + */ + informacaoAdicional?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; + }; + /** + * ParceiroId vinculado ao pedido (optional) + */ + canalId?: number; + /** + * Dados do pedido no marketplace (optional) + */ + omniChannel?: { + /** + * Id do pedido que o cliente vê no momento que fecha a compra + */ + pedidoIdPublico?: string; + /** + * Id interno do marketplace + */ + pedidoIdPrivado?: string; + /** + * Dados do pedido no integrador + */ + integrador?: { + /** + * Nome do parceiro integrador + */ + nome?: string; + /** + * Numero do pedido dentro do integrador + */ + pedidoId?: string; + /** + * Url do pedido dentro painel do integrador + */ + pedidoUrl?: string; + }; + }; + /** + * Id da transação (optional) + */ + transacaoId?: number; + /** + * Observação do pedido (optional) + */ + observacao?: string; + /** + * Se um pedido é valido (optional) + */ + valido?: boolean; + /** + * Cupom de desconto (optional) + */ + cupomDesconto?: string; + /** + * IP da criação do pedido (optional) + */ + ip?: string; + /** + * ID do usuário master que realizou o pedido, se houver (optional) + */ + usuarioMaster?: number; + }; + }; + /** @description Lista de portfolios */ + "GET /portfolios": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }[]; + }; + /** @description Lista de imagens vinculadas a um produtos */ + "GET /produtos/:identificador/imagens": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + produtosIrmaos?: boolean; + }; + response: { + idImagem?: number; + nomeArquivo?: string; + url?: string; + ordem?: number; + estampa?: boolean; + exibirMiniatura?: boolean; + }[]; + }; + /** @description Limite de crédito de um usuário específico */ + "GET /usuarios/limiteCreditoPorUsuarioId/:usuarioId": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }; + }; + /** @description Deleta o SEO de um produto específico */ + "DELETE /produtos/:identificador/seo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + }; + /** @description Adiciona um vínculo entre usuário e parceiro */ + "POST /usuarios/:email/parceiro": { + body: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + /** + * Vinculo vitalício (optional) + */ + vinculoVitalicio?: boolean; + /** + * Data inicial do vinculo entre usuário e parceiro (optional) + */ + dataInicial?: string; + /** + * Data final do vinculo entre usuário e parceiro (optional) + */ + dataFinal?: string; + }; + }; + /** @description Atualiza um banner existente */ + "PUT /banners/:bannerId": { + body: { + /** + * Nome do banner + */ + nome?: string; + /** + * Data de inicio de exibição do banner + */ + dataInicio?: string; + /** + * Data de termino de exibição do banner (optional) + */ + dataFim?: string; + /** + * Banner ativo/inativo (optional) + */ + ativo?: boolean; + /** + * Detalhes do banner + */ + detalhe?: { + /** + * Local de posicionamento do banner + */ + posicionamentoId?: number; + /** + * Imagem do banner (caso o campo "UrlBanner" estiver preenchido esse campo será desconsiderado) (optional) + */ + imagemBanner?: { + /** + * string da imagem em base 64 + */ + base64?: string; + /** + * formato da imagem + */ + formato?: "PNG" | "JPG" | "JPEG"; + /** + * nome da imagem + */ + nome?: string; + }; + /** + * Url de onde o banner deve ser carregado (Ex.: http://www.site.com.br/banner.swf). O Banner poderá ser do tipo flash ou imagem (optional) + */ + urlBanner?: string; + /** + * Ordem de exibição do banner (optional) + */ + ordemExibicao?: number; + /** + * Se o banner deve ou não abrir em nova aba (optional) + */ + abrirLinkNovaAba?: boolean; + /** + * Largura do banner em pixels (optional) + */ + largura?: number; + /** + * Altura do banner em pixels (optional) + */ + altura?: number; + /** + * Title da imagem do banner (optional) + */ + title?: string; + /** + * Url de destino para quando o usuário clicar no Banner (optional) + */ + urlClique?: string; + /** + * URL para um Banner alternativo que será exibido caso ocorra algum problema para exibição do Banner (optional) + */ + urlBannerAlternativo?: string; + /** + * Title alternativo que será exibido caso ocorra algum problema para a exibição do Banner + */ + textoAlternativo?: string; + }; + /** + * Dias da semana que o banner deverá ser exibido (optional) + */ + diasExibicao?: { + /** + * Se o banner deverá ser exibido todos os dias (caso esse campo estiver preenchido como "true" os demais serão desconsiderados) + */ + todosDias?: boolean; + /** + * Se o banner deverá ser apresentado no domingo + */ + domingo?: boolean; + /** + * Se o banner deverá ser apresentado na segunda + */ + segunda?: boolean; + /** + * Se o banner deverá ser apresentado na terça + */ + terca?: boolean; + /** + * Se o banner deverá ser apresentado na quarta + */ + quarta?: boolean; + /** + * Se o banner deverá ser apresentado na quinta + */ + quinta?: boolean; + /** + * Se o banner deverá ser apresentado na sexta + */ + sexta?: boolean; + /** + * Se o banner deverá ser apresentado no sábado + */ + sabado?: boolean; + }; + /** + * Apresentação do banner (optional) + */ + apresentacao?: { + /** + * Se o banner deverá ser exibido em todo o site + */ + exibirNoSite?: boolean; + /** + * Se o banner deverá ser exibido em todas as buscas + */ + exibirEmTodasBuscas?: boolean; + /** + * Se o banner não deverá ser exibido em nenhuma busca (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ + naoExibirEmBuscas?: boolean; + /** + * Termos que o banner será exibido na busca + */ + termosBusca?: string; + /** + * Se o banner deverá ser exibido em todas categorias (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) + */ + exibirEmTodasCategorias?: boolean; + /** + * Em quais hotsites o banner deve ser exibido + */ + listaHotsites?: { + /** + * Se o banner deverá ser exibido em todos as hotsite's (Caso esse campo estiver como "true" o campo HotSites será desconsiderado) (optional) + */ + exibirEmTodosHotsites?: boolean; + /** + * Lista de hotsite's que o banner será exibido + */ + hotsites?: { + /** + * Id do hotsite (optional) + */ + hotSiteId?: number; + }[]; + }; + }; + /** + * Em quais parceiros o banner deve ser exibido + */ + listaParceiros?: { + /** + * Se o banner deverá ser exibido em todos parceiros (Caso esse campo estiver como "true" o campo TermosBusca será desconsiderado) (optional) + */ + exibirEmTodosParceiros?: boolean; + /** + * Lista de parceiros que o banner será exibido + */ + parceiros?: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + }[]; + }; + }; + }; + /** @description Retorna usuário encontrado */ + "GET /usuarios/:email/enderecos": { + response: { + enderecoId?: number; + nomeEndereco?: string; + rua?: string; + numero?: string; + complemento?: string; + referencia?: string; + bairro?: string; + cidade?: string; + estado?: string; + cep?: string; + utilizadoUltimoPedido?: boolean; + pais?: string; + }[]; + }; + /** @description Exclui um Script */ + "DELETE /gestorscripts/scripts/:scriptId": {}; + /** @description Ativa ou desativa um endereço de um usuário com base no id do usuário */ + "PUT /usuarios/:usuarioId/enderecos/:enderecoId/ativar": { + body: { + /** + * Status do endereço + */ + status?: boolean; + }; + }; + /** @description Atualiza um vínculo entre usuário e parceiro */ + "PUT /usuarios/:email/parceiro": { + body: { + /** + * Vinculo vitalício (optional) + */ + vinculoVitalicio?: boolean; + /** + * Data inicial do vinculo entre usuário e parceiro (optional) + */ + dataInicial?: string; + /** + * Data final do vinculo entre usuário e parceiro (optional) + */ + dataFinal?: string; + }; + }; + /** @description Ativa ou desativa um Seller */ + "PUT /resellers/:resellerId/status": { + body: { + /** + * Status do seller (ativo / inativo) + */ + ativo?: boolean; + }; + }; + /** @description Lista de produtos */ + "GET /produtos": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Lista de categorias que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as categorias + */ + categorias?: string; + /** + * Lista de fabricantes que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + fabricantes?: string; + /** + * Lista de centros de distribuição que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará produtos de todos os cd's + */ + centrosDistribuicao?: string; + /** + * Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência + */ + alteradosPartirDe?: string; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Retorna apenas os produtos que estão marcados como válido + */ + somenteValidos?: boolean; + /** + * Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + consumo?: { + quantidadeDias?: number; + enviarEmail?: boolean; + }; + prazoValidade?: number; + }[]; + }; + /** @description Remove um Atacarejo */ + "DELETE /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Inserir autor */ + "POST /autores": { + body: { + /** + * Nome do Autor + */ + nome?: string; + /** + * Status do autor + */ + ativo?: boolean; + }; + }; + /** @description Lista dos estados */ + "GET /lojasFisicas/estados": { + response: { + estadoId?: number; + nome?: string; + sigla?: string; + regiao?: string; + }[]; + }; + /** @description Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais. */ + "GET /produtos/:identificador": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + /** + * Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco + */ + camposAdicionais?: string[]; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + consumo?: { + quantidadeDias?: number; + enviarEmail?: boolean; + }; + prazoValidade?: number; + }; + }; + /** @description Lista de versões */ + "GET /gestorscripts/scripts/:scriptId/versoes": { + response: { + versaoId?: number; + scriptId?: number; + dataCadastro?: string; + identificadorPagina?: string; + publicado?: boolean; + usuario?: string; + }[]; + }; + /** @description Reseller específico */ + "GET /resellers/token": { + response: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + }; + /** @description Insere uma versão para um script existente */ + "POST /gestorscripts/scripts/:scriptId/versoes": { + body: { + /** + * Identificador da página + */ + identificadorPagina?: string; + /** + * Conteúdo do script + */ + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; + }; + }; + /** @description Atualiza uma categoria utilizando o id do erp como identificador */ + "PUT /categorias/erp/:id": { + body: { + /** + * Nome da categoria (optional) + */ + nome?: string; + /** + * Id da categoria pai (optional) + */ + categoriaPaiId?: number; + /** + * Id da categoria ERP (optional) + */ + categoriaERPId?: string; + /** + * Categoria ativo/inativo (optional) + */ + ativo?: boolean; + /** + * Categoria de reseller (optional) + */ + isReseller?: boolean; + /** + * Exibir Matriz de Atributos (optional) + */ + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + /** + * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) + */ + quantidadeMaximaCompraUnidade?: number; + /** + * Informe o valor mínimo para compra em produtos desta categoria (optional) + */ + valorMinimoCompra?: number; + /** + * Informe se será exibida no menu (optional) + */ + exibeMenu?: boolean; + }; + }; + /** @description Templates */ + "GET /templates": {}; + /** @description Insere um novo usuário */ + "POST /usuarios": { + body: { + /** + * Tipo de pessoa + */ + tipoPessoa?: "Fisica" | "Juridica"; + /** + * Origem do contato + */ + origemContato?: + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; + /** + * Tipo Sexo (optional) + */ + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; + /** + * Nome do usuário (Max Length: 100) + */ + nome?: string; + /** + * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + cpf?: string; + /** + * E-mail do usuário (Max Length: 100) + */ + email?: string; + /** + * RG do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + rg?: string; + /** + * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) + */ + telefoneResidencial?: string; + /** + * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) + */ + telefoneCelular?: string; + /** + * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) + */ + telefoneComercial?: string; + /** + * Data de nascimento (optional) + */ + dataNascimento?: string; + /** + * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) + */ + razaoSocial?: string; + /** + * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + cnpj?: string; + /** + * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + inscricaoEstadual?: string; + /** + * Responsável(Max Length: 100) (optional) + */ + responsavel?: string; + /** + * Data de criação do cadastro (optional) + */ + dataCriacao?: string; + /** + * Data de atualização do cadastro (optional) + */ + dataAtualizacao?: string; + /** + * Se o usuário é revendedor (optional) + */ + revendedor?: boolean; + /** + * Informação cadastral (optional) + */ + listaInformacaoCadastral?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; + /** + * Avatar (Max Length: 50) (optional) + */ + avatar?: string; + /** + * IP do usuário (Max Length: 20) (optional) + */ + ip?: string; + /** + * Seta ou retorna o valor de Aprovado (optional) + */ + aprovado?: boolean; + }; + }; + /** @description Lista de pedidos */ + "GET /pedidos": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de situações que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as situações + */ + situacoesPedido?: string; + /** + * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + */ + formasPagamento?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado + */ + email?: string; + /** + * Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado) + */ + valido?: boolean; + /** + * Deverá retornar apenas pedidos que o produto de determinado sku foi comprado + */ + sku?: string; + /** + * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + */ + apenasAssinaturas?: boolean; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** @description Dados da loja */ + "GET /loja": { + response: { + nome?: string; + urlSite?: string; + urlCarrinho?: string; + }; + }; + /** @description Indicadores de Faturamento */ + "GET /dashboard/faturamento": { + searchParams: { + /** + * Data inicial dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataInicialComparativo?: string; + /** + * Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd) + */ + dataFinalComparativo?: string; + }; + response: { + indicadorReceita?: number; + indicadorPedido?: number; + indicadorTicketMedio?: number; + indicadorReceitaComparativo?: number; + indicadorPedidoComparativo?: number; + indicadorTicketMedioComparativo?: number; + indicadorReceitaFormatado?: string; + indicadorPedidoFormatado?: string; + indicadorTicketMedioFormatado?: string; + indicadorReceitaComparativoFormatado?: string; + indicadorPedidoComparativoFormatado?: string; + indicadorTicketMedioComparativoFormatado?: string; + indicadorReceitaPorcentagem?: string; + indicadorPedidoPorcentagem?: string; + indicadorTicketMedioPorcentagem?: string; + }; + }; + /** @description Grupo de assinatura */ + "GET /assinaturas/grupoassinatura": { + response: { + grupoAssinaturaId?: number; + nome?: string; + recorrencias?: { + recorrenciaId?: number; + nome?: string; + dias?: number; + }[]; + }[]; + }; + /** @description Atualiza um produto com base nos dados enviados */ + "PUT /produtos/:identificador": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Representa o ProdutoId agrupador por variante (optional) + */ + idPaiExterno?: string; + /** + * Representa o ParentId agrupador por parent (optional) + */ + idVinculoExterno?: string; + /** + * (Max Length: 50) Sku do produto + */ + sku?: string; + /** + * (Max Length: 300) Nome do produto variante + */ + nome?: string; + /** + * Nome do produto (pai do variante) (optional) + */ + nomeProdutoPai?: string; + /** + * Tipo de exibição da matriz de atributos (optional) + */ + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + /** + * Se o produto aceita contra proposta (optional) + */ + contraProposta?: boolean; + /** + * (Max Length: 100) Nome do fabricante + */ + fabricante?: string; + /** + * (Max Length: 500) Nome do autor (optional) + */ + autor?: string; + /** + * (Max Length: 100) Nome da editora (optional) + */ + editora?: string; + /** + * (Max Length: 100) Nome da coleção (optional) + */ + colecao?: string; + /** + * (Max Length: 100) Nome do gênero (optional) + */ + genero?: string; + /** + * Max Length: 8, "0000.0000,00") Preço de custo do produto variante (optional) + */ + precoCusto?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço De" do produto variante (optional) + */ + precoDe?: number; + /** + * (Max Length: 8, "0000.0000,00") "Preço Por" de venda do produto variante + */ + precoPor?: number; + /** + * (Max Length: 8, "0000.0000,00") Fator multiplicador que gera o preço de exibição do produto.Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) + */ + fatorMultiplicadorPreco?: number; + /** + * Prazo de entrega do produto variante (optional) + */ + prazoEntrega?: number; + /** + * Define se um produto variante é valido ou não (optional) + */ + valido?: boolean; + /** + * Define se um produto deve ser exibido no site (optional) + */ + exibirSite?: boolean; + /** + * Define a qual regra de calculo de frete o produto vai pertencer + */ + freteGratis?: "Sempre" | "Nunca" | "Neutro" | "Desconsiderar_Regras"; + /** + * Define se o produto variante tem troca grátis (optional) + */ + trocaGratis?: boolean; + /** + * (Max Length: 8, "0000.0000,00") Peso do produto variante, em gramas (g) + */ + peso?: number; + /** + * (Max Length: 8, "0000.0000,00") Altura do produto variante, em centímetros (cm). + */ + altura?: number; + /** + * (Max Length: 8, "0000.0000,00") Comprimento do produto variante, em centímetros (cm). + */ + comprimento?: number; + /** + * (Max Length: 8, "0000.0000,00") Largura do produto variante, em centímetros (cm). + */ + largura?: number; + /** + * Define se o produto variante tem garantia (optional) + */ + garantia?: number; + /** + * Define se o produto contém televendas (optional) + */ + isTelevendas?: boolean; + /** + * (Max Length: 25) EAN do produto variante (optional) + */ + ean?: string; + /** + * (Max Length: 255) Localização no estoque do produto variante (optional) + */ + localizacaoEstoque?: string; + /** + * Dados de atacado do produto variante (optional) + */ + listaAtacado?: { + /** + * (Max Length: 8, "0000.0000,00") - Preco Por do item por atacado + */ + precoPor?: number; + /** + * Quantidade para compra de atacado + */ + quantidade?: number; + }[]; + /** + * Lista de estoque/centro de distribuição do produto. Obrigatório se valido for true (optional) + */ + estoque?: { + /** + * Estoque físico do produto + */ + estoqueFisico?: number; + /** + * Estoque reservado do produto + */ + estoqueReservado?: number; + /** + * Id do centro de distribuição do estoque do produto + */ + centroDistribuicaoId?: number; + /** + * Quantidade para ativar o alerta de estoque + */ + alertaEstoque?: number; + }[]; + /** + * Lista de atributos do produto + */ + listaAtributos?: { + /** + * (Max Length: 100) - Define o nome do atributo + */ + nome?: string; + /** + * (Max Length: 8, "0000.0000,00") - Define o valor do atributo + */ + valor?: string; + /** + * Define se o atributo deverá ser exibido + */ + exibir?: boolean; + }[]; + /** + * Quantidade máxima de compra do produto variante (optional) + */ + quantidadeMaximaCompraUnidade?: number; + /** + * Quantidade mínima de compra do produto variante (optional) + */ + quantidadeMinimaCompraUnidade?: number; + /** + * Condição do produto variante (optional) + */ + condicao?: "Novo" | "Usado" | "Renovado" | "Danificado"; + /** + * Url do vídeo do Produto (optional) + */ + urlVideo?: string; + /** + * Se o produto aparece no Spot (optional) + */ + spot?: boolean; + /** + * Se o produto aparece na Url (optional) + */ + paginaProduto?: boolean; + /** + * Se o produto aparece no Marketplace (optional) + */ + marketplace?: boolean; + /** + * Se o produto aparece somente nos Parceiros + */ + somenteParceiros?: boolean; + /** + * Se o produto deve ser agrupado pelo EAN (optional) + */ + buyBox?: boolean; + /** + * Prazo de validade ou consumo do produto (optional) + */ + prazoValidade?: number; + /** + * Dados de consumo de produto e se deve enviar os dias de consumo por e-mail (optional) + */ + consumo?: { + /** + * Quantidade de Dias (optional) + */ + quantidadeDias?: number; + /** + * Enviar e-mail (optional) + */ + enviarEmail?: boolean; + }; + }; + }; + /** @description Lista de pedidos */ + "GET /pedidos/:pedidoId/rastreamento": { + response: { + pedidoRastreamentoId?: number; + dataAtualizacao?: string; + notaFiscal?: string; + serieNF?: string; + cfop?: number; + dataEnviado?: string; + urlNFE?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + transportadora?: string; + dataEntrega?: string; + }; + }; + /** @description Atualiza rastreamento de produto completo (com os dados da N.F.) */ + "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": + { + body: { + /** + * Nota Fiscal + */ + notaFiscal?: string; + /** + * CFOP + */ + cfop?: number; + /** + * Data Enviado + */ + dataEnviado?: string; + /** + * Chave de acesso NFE + */ + chaveAcessoNFE?: string; + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de rastreamento (optional) + */ + urlRastreamento?: string; + /** + * Transportadora (optional) + */ + transportadora?: string; + /** + * Data da entrega (optional) + */ + dataEntrega?: string; + }; + }; + /** @description Insere um novo detalhe de frete vinculado a um contrato de frete */ + "POST /fretes/:freteId/detalhes": { + body: { + /** + * Informe o cep inicial (optional) + */ + cepInicial?: number; + /** + * Informe o cep final (optional) + */ + cepFinal?: number; + /** + * Variações de detalhe do frete (optional) + */ + variacoesFreteDetalhe?: { + /** + * Informe o peso inicial + */ + pesoInicial?: number; + /** + * Informe o peso final + */ + pesoFinal?: number; + /** + * Informe o valor do frete + */ + valorFrete?: number; + /** + * Informe o prazo de entrega + */ + prazoEntrega?: number; + /** + * Informe o valor preço + */ + valorPreco?: number; + /** + * Informe o valor peso + */ + valorPeso?: number; + }[]; + }; + }; + /** @description Insere um novo portfolio */ + "POST /portfolios": { + body: { + /** + * Nome do portfolio + */ + nome?: string; + }; + }; + /** @description Lista de banners */ + "GET /banners": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadePorPagina?: number; + }; + response: { + id?: number; + nome?: string; + dataInicio?: string; + dataFim?: string; + ativo?: boolean; + detalhe?: { + posicionamentoId?: number; + urlBanner?: string; + imagemBanner?: { + nome?: string; + base64?: string; + formato?: string; + }; + ordemExibicao?: number; + abrirBannerNovaAba?: boolean; + largura?: number; + altura?: number; + title?: string; + urlClique?: string; + urlBannerAlternativo?: string; + titleAlternativo?: string; + diasExibicao?: { + todosDias?: boolean; + domingo?: boolean; + segunda?: boolean; + terca?: boolean; + quarta?: boolean; + quinta?: boolean; + sexta?: boolean; + sabado?: boolean; + }; + textoAlternativo?: string; + }; + apresentacao?: { + exibirNoSite?: boolean; + exibirEmTodasBuscas?: boolean; + naoExibirEmBuscas?: boolean; + termosBusca?: string; + listaHotsites?: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + exibirEmTodasCategorias?: boolean; + listaParceiros?: { + exibirEmTodosParceiros?: boolean; + parceiros?: { + parceiroId?: number; + }[]; + }; + }; + }[]; + }; + /** @description Pedido encontrado */ + "GET /pedidos/:pedidoId": { + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }; + }; + /** @description Avatar do usuário encontrado */ + "GET /usuarios/:email/avatar": { + response: { + urlAvatar?: string; + }; + }; + /** @description Lista de identificadores de conteúdos vinculados ao hotsite */ + "GET /hotsites/:hotsiteId/conteudos": { + response: { + conteudoId?: number; + }[]; + }; + /** @description Atualiza um campo de cadastro personalizado pelo id */ + "PUT /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": { + body: { + /** + * Nome do campo (optional) + */ + nome?: string; + /** + * Se o campo será obrigatório (optional) + */ + obrigatorio?: boolean; + /** + * Ordem (optional) + */ + ordem?: number; + }; + }; + /** @description Dados do serviço de frete do pedido */ + "GET /pedidos/:pedidoId/frete": {}; + /** @description Atualiza uma tabela de preços */ + "PUT /tabelaPrecos/:tabelaPrecoId": { + body: { + /** + * Nome da tabela de preço + */ + nome?: string; + /** + * Data que inicia a tabela de preço + */ + dataInicial?: string; + /** + * Data de término da tabela de preço + */ + dataFinal?: string; + /** + * Status da tabela de preço + */ + ativo?: boolean; + }; + }; + /** @description Atualiza a situação do status do pedido */ + "PUT /pedidos/:pedidoId/status": { + body: { + /** + * Id da situação do pedido + */ + RAW_BODY: { + /** + * Id da situação do pedido + */ + id?: number; + }; + }; + }; + /** @description Lista de Tópicos */ + "GET /webhook/Topicos": { + response: { + nome?: string; + descricao?: string; + payload?: string; + }[]; + }; + /** @description Seta o pedido como integrado */ + "POST /pedidos/complete": { + body: { + /** + * Pedido que se deseja inserir o "complete" + */ + RAW_BODY: { + /** + * Id do pedido + */ + pedidoId?: number; + }; + }; + }; + /** @description Deleta um portfolio */ + "DELETE /portfolios/:portfolioId": {}; + /** @description Retorna se o produto variante está disponível ou não */ + "GET /produtos/:identificador/disponibilidade": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Lista de formas de pagamento */ + "GET /formasPagamento": { + response: { + formaPagamentoId?: number; + nome?: string; + nomeExibicao?: string; + descricao?: string; + }[]; + }; + /** @description Último status do pedido */ + "GET /pedidos/:pedidoId/status": { + response: { + situacaoPedidoId?: number; + dataAtualizacao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + nomeTransportadora?: string; + produtos?: { + produtoVarianteId?: number; + situacaoProdutoId?: number; + quantidade?: number; + centroDistribuicaoId?: number; + }[]; + }; + }; + /** @description Lista de pedidos */ + "GET /pedidos/:pedidoId/rastreamento/produtos": { + response: { + produtoVarianteId?: number; + rastreamentos?: { + pedidoRastreamentoProdutoId?: number; + quantidade?: number; + dataAtualizacao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + transportadora?: string; + centroDistribuicaoId?: number; + dataEntrega?: string; + }[]; + }[]; + }; + /** @description Altera o status de um portfolio */ + "PUT /portfolios/:portfolioId/status": { + body: { + /** + * Status do portfolio: true ou false + */ + RAW_BODY?: { + /** + * Novo status do portfolio + */ + ativo?: boolean; + }; + }; + }; + /** @description Limite de crédito que estão vinculados aos usuários */ + "GET /usuarios/limiteCredito": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }[]; + }; + /** @description Exclui uma imagem de um produto */ + "DELETE /produtos/:identificador/imagens/:id": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Atualiza um atributo */ + "PUT /atributos/:nome": { + body: { + /** + * Nome do atributo (optional) + */ + nome?: string; + /** + * Tipo do atributo (optional) + */ + tipo?: + | "Selecao" + | "Filtro" + | "Comparacao" + | "Configuracao" + | "ExclusivoGoogle"; + /** + * Tipo de exibição (optional) + */ + tipoExibicao?: + | "Combo" + | "Div" + | "DivComCor" + | "DivComFotoDoProdutoVariante" + | "Javascript"; + /** + * Prioridade do atributo (optional) + */ + prioridade?: number; + }; + }; + /** @description Atualiza um portfolio */ + "PUT /portfolios/:portfolioId": { + body: { + /** + * Nome do portfolio + */ + nome?: string; + }; + }; + /** @description Extrato retornado com sucesso */ + "GET /contascorrentes/:email/extrato": { + searchParams: { + /** + * Data Inicial para verificar extrato + */ + dataInicial?: string; + /** + * Data Final para verificar extrato + */ + dataFinal?: string; + }; + response: { + data?: string; + historico?: string; + valor?: number; + tipoLancamento?: string; + observacao?: string; + visivelParaCliente?: boolean; + }[]; + }; + /** @description Fabricante encontrado */ + "GET /fabricantes/:fabricanteId": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; + }; + }; + /** @description Insere uma observação a um pedido */ + "POST /pedidos/:pedidoId/observacao": { + body: { + /** + * Objeto com os dados da observação (optional) + */ + RAW_BODY: { + /** + * Texto da observação + */ + observacao?: string; + /** + * Nome do usuário que está inserindo a observação + */ + usuario?: string; + /** + * Se a observação é publica ou privada + */ + publica?: boolean; + }; + }; + }; + /** @description Lista de tipos de evento */ + "GET /tiposEvento": { + searchParams: { + /** + * Status do tipo de evento + */ + ativo?: boolean; + /** + * Se o tipo de evento está disponível + */ + disponivel?: boolean; + /** + * Nome do tipo de evento + */ + nome?: string; + }; + response: { + tipoEventoId?: number; + nome?: string; + tipoEntrega?: string; + tipoDisponibilizacao?: string; + permitirRemocaoAutomaticaProdutos?: boolean; + corHexTituloInformacoes?: string; + corHexCorpoInformacoes?: string; + numeroAbasInformacoes?: number; + quantidadeDiasParaEventoExpirar?: number; + numeroLocaisEvento?: number; + ativo?: boolean; + disponivel?: boolean; + tipoBeneficiarioFrete?: string; + caminhoLogoEvento?: string; + caminhoSubTemplate?: string; + sugestaoProdutos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + }[]; + }[]; + }; + /** @description Lista de centros de distribuição */ + "GET /centrosdistribuicao": { + response: { + id?: number; + nome?: string; + cep?: number; + padrao?: boolean; + }[]; + }; + /** @description Rastreamento de produto encontrado */ + "GET /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId": + { + response: { + pedidoRastreamentoProdutoId?: number; + pedidoId?: number; + produtoVarianteId?: number; + pedidoProdutoId?: number; + dataInclusao?: string; + dataAlteracao?: string; + notaFiscal?: string; + cfop?: number; + dataEnviado?: string; + chaveAcessoNFE?: string; + rastreamento?: string; + urlRastreamento?: string; + quantidade?: number; + urlNFE?: string; + serieNFE?: string; + tipoPostagem?: string; + centroDistribuicao?: string; + transportadora?: string; + dataEntrega?: string; + }; + }; + /** @description Lista de avaliações de produtos */ + "GET /produtoavaliacao": { + searchParams: { + /** + * Referente ao status que libera a visualização da avaliação no site + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + produtoVarianteId?: number; + sku?: string; + produtoAvaliacaoId?: number; + comentario?: string; + avaliacao?: number; + usuarioId?: number; + dataAvaliacao?: string; + nome?: string; + email?: string; + status?: string; + }[]; + }; + /** @description Conteúdo encontrado */ + "GET /conteudos/:conteudoId": {}; + /** @description Lista de usuários */ + "GET /usuarios": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro de data + */ + enumTipoFiltroData?: "DataAlteracao" | "DataCriacao"; + /** + * Status de aprovação + */ + aprovado?: boolean; + }; + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }[]; + }; + /** @description Desvincula um ou mais conteúdos de um hotsite específico */ + "DELETE /hotsites/:hotsiteId/conteudos": { + body: { + /** + * Lista de identificadores de conteúdos a serem desvinculados + */ + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; + }; + }; + /** @description Atualiza o status do tipo de evento, ativando-o ou inativando-o */ + "PUT /tiposEvento/:tipoEventoId/AlterarStatus": {}; + /** @description Exclui os detalhes de um contrato de frete */ + "DELETE /fretes/:freteId/detalhes": {}; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /tiposEvento/:tipoEventoId/produtos": { + response: { + tipoEventoId?: number; + produtoVariantePrincipalId?: number; + }[]; + }; + /** @description Atualiza a ativação automática de produtos de um Seller */ + "PUT /resellers/:resellerId/ativacaoAutomaticaProdutos": { + body: { + /** + * Status da ativação automática de produtos + */ + ativo?: boolean; + }; + }; + /** @description Insere um SEO para um produto específico */ + "POST /produtos/:identificador/seo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { + /** + * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) + */ + tagCanonical?: string; + /** + * Informe o title da página do produto (optional) + */ + title?: string; + /** + * Informe os dados da Meta Tag (optional) + */ + metaTags?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; + }[]; + }; + }; + /** @description Gráfico Forma de Pagamento */ + "GET /dashboard/graficoformapagamento": { + searchParams: { + /** + * Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + nome?: string; + quantidade?: number; + cor?: string; + }[]; + }; + /** @description Lista de números de pedidos ainda não integrados */ + "GET /pedidos/naoIntegrados": { + response: { + pedidoId?: number; + }[]; + }; + /** @description Dados da lista de desejos de um usuário */ + "GET /usuarios/:usuarioId/listaDesejos": { + response: { + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + dataAdicao?: string; + }[]; + }; + /** @description Portfolio encontrado */ + "GET /portfolios/:portfolioId": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }; + }; + /** @description Atualiza lista de produtos vinculados a um evento removendo os itens vinculados anteriormente e mantendo apenas os enviados pelo request */ + "PUT /eventos/:eventoId/produtos": { + body: { + /** + * Identificadores dos produtos variantes a serem vinculados ao evento desejado + */ + produtosVariante?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Usuários encontrados */ + "GET /parceiros/:nome/usuarios": { + response: { + usuarioId?: number; + email?: string; + ativo?: boolean; + dataInicial?: string; + dataFinal?: string; + vinculoVitalicio?: boolean; + }[]; + }; + /** @description Indicador dos Novos Compradores */ + "GET /dashboard/novoscompradores": { + searchParams: { + /** + * Data inicial dos novos compradores que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos novos compradores que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorComprador?: string; + }; + }; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos": { + searchParams: { + /** + * Data de inicio do evento + */ + dataInicial?: string; + /** + * Data do termino do evento + */ + dataFinal?: string; + /** + * Status do evento + */ + disponivel?: boolean; + /** + * Titulo do evento + */ + titulo?: string; + /** + * Email do Usuário + */ + usuarioEmail?: string; + /** + * Identificador do Tipo de Evento + */ + tipoEventoId?: number; + }; + response: { + eventoId?: number; + tipoEventoId?: number; + userId?: number; + enderecoEntregaId?: number; + data?: string; + dataCriacao?: string; + titulo?: string; + url?: string; + disponivel?: boolean; + diasDepoisEvento?: number; + diasAntesEvento?: number; + urlLogoEvento?: string; + urlCapaEvento?: string; + proprietarioEvento?: string; + abaInfo01Habilitado?: boolean; + textoInfo01?: string; + conteudoInfo01?: string; + abaInfo02Habilitado?: boolean; + textoInfo02?: string; + conteudoInfo02?: string; + abaMensagemHabilitado?: boolean; + fotos?: string; + enumTipoListaPresenteId?: string; + enumTipoEntregaId?: string; + eventoProdutoSelecionado?: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + enderecoEvento?: { + enderecoEventoId?: number; + eventoId?: number; + nome?: string; + cep?: string; + endereco?: string; + numero?: string; + bairro?: string; + cidade?: string; + estado?: string; + }[]; + }[]; + }; + /** @description Realiza um novo lançamento na conta corrente do cliente */ + "POST /contascorrentes/:email": { + body: { + /** + * Valor da conta corrente (optional) + */ + valor?: number; + /** + * Tipo de Lançamento (optional) + */ + tipoLancamento?: "Credito" | "Debito"; + /** + * Observação (optional) + */ + observacao?: string; + /** + * Se será visível para o cliente (optional) + */ + visivelParaCliente?: boolean; + }; + }; + /** @description Retorna todas as informações de um produto específico */ + "GET /produtos/:identificador/informacoes": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + }; + response: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + }; + /** @description Insere um novo atributo */ + "POST /atributos": { + body: { + /** + * Nome do atributo (optional) + */ + nome?: string; + /** + * Tipo do atributo (optional) + */ + tipo?: + | "Selecao" + | "Filtro" + | "Comparacao" + | "Configuracao" + | "ExclusivoGoogle"; + /** + * Tipo de exibição (optional) + */ + tipoExibicao?: + | "Combo" + | "Div" + | "DivComCor" + | "DivComFotoDoProdutoVariante" + | "Javascript"; + /** + * Prioridade do atributo (optional) + */ + prioridade?: number; + }; + }; + /** @description Indicador do Carrinho Abandonado */ + "GET /dashboard/carrinhoabandonado": { + searchParams: { + /** + * Data inicial dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos carrinhos abandonados que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorCarrinhoAbandonado?: string; + }; + }; + /** @description Deleta um ou mais Metatags de produto */ + "DELETE /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { + /** + * Lista de identificadores de metatags (optional) + */ + metatags?: { + /** + * Identificador do MetaTag + */ + metatagId?: number; + }[]; + }; + }; + /** @description Frete encontrado */ + "GET /fretes/:freteId": { + response: { + freteId?: number; + nome?: string; + ativo?: boolean; + volumeMaximo?: number; + pesoCubado?: number; + entregaAgendadaConfiguracaoId?: number; + linkRastreamento?: string; + ehAssinatura?: boolean; + larguraMaxima?: number; + alturaMaxima?: number; + comprimentoMaximo?: number; + limiteMaximoDimensoes?: number; + limitePesoCubado?: number; + tempoMinimoDespacho?: number; + centroDistribuicaoId?: number; + valorMinimoProdutos?: number; + }; + }; + /** @description Relatório de transações de um determinado período */ + "GET /dashboard/transacoes": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** @description Lista de produtos de uma tabela de preços */ + "GET /tabelaPrecos/:tabelaPrecoId/produtos": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + tabelaPrecoProdutoVarianteId?: number; + tabelaPrecoId?: number; + sku?: string; + produtoVarianteId?: number; + precoDe?: number; + precoPor?: number; + }[]; + }; + /** @description Insere um novo script */ + "POST /gestorscripts/scripts": { + body: { + /** + * Nome do script + */ + nome?: string; + /** + * Data inicial do script + */ + dataInicial?: string; + /** + * Data final do script + */ + dataFinal?: string; + /** + * Informe se o script está ativo ou não + */ + ativo?: boolean; + /** + * Prioridade do script + */ + prioridade?: number; + /** + * Posição do script + */ + posicao?: + | "HeaderPrimeiraLinha" + | "HeaderUltimaLinha" + | "BodyPrimeiraLinha" + | "BodyUltimaLinha" + | "FooterPrimeiraLinha" + | "FooterUltimeLinha"; + /** + * Tipo da página do script + */ + tipoPagina?: + | "Todas" + | "Home" + | "Busca" + | "Categoria" + | "Fabricante" + | "Estaticas" + | "Produto" + | "Carrinho"; + /** + * Identificador da página + */ + identificadorPagina?: string; + /** + * Conteúdo do script + */ + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; + }; + }; + /** @description Assinaturas com erro na loja */ + "GET /assinaturas/erros": { + searchParams: { + /** + * Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Erros já resolvidos ou não + */ + resolvidos?: boolean; + }; + }; + /** @description Método que realiza uma cotação de frete */ + "POST /fretes/cotacoes": { + searchParams: { + /** + * Cep de entrega + */ + cep?: string; + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define se deve retornar as opções de retirada em loja ("False" por padrão) (optional) + */ + retiradaLoja?: boolean; + }; + body: { + /** + * Valor total do pedido (optional) + */ + valorTotal?: number; + /** + * Lista de produtos da cotação + */ + produtos?: { + /** + * Id do produto variante + */ + identificador?: string; + /** + * Quantidade do produto + */ + quantidade?: number; + }[]; + }; + response: { + id?: string; + nome?: string; + prazo?: number; + tabelaFreteId?: string; + tipo?: string; + valor?: number; + produtos?: { + produtoVarianteId?: number; + valor?: number; + }[]; + }[]; + }; + /** @description Remove uma lista de range de cep de uma Loja Física */ + "DELETE /lojasFisicas/:lojaFisicaId/rangeCep": { + body: { + /** + * Lista de range de cep a serem excluídos da loja física + */ + RAW_BODY: { + /** + * Id da faixa de cep a ser deletado + */ + rangeCepId?: number; + }[]; + }; + }; + /** @description Insere um endereço para um usuário pelo id do usuário */ + "POST /usuarios/:usuarioId/enderecos": { + body: { + /** + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + */ + nomeEndereco?: string; + /** + * Nome da rua (Max Length: 500) + */ + rua?: string; + /** + * Número do local (Max Length: 50) + */ + numero?: string; + /** + * Complemento (Max Length: 250) (optional) + */ + complemento?: string; + /** + * Referência para a localização do endereço (Max Length: 500) (optional) + */ + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; + }; + }; + /** @description Categoria excluída com sucesso */ + "DELETE /categorias/erp/:id": {}; + /** @description Retorna uma lista de vínculos entre usuário e parceiro */ + "GET /usuarios/:email/parceiros": {}; + /** @description Produtos de uma assinatura */ + "GET /assinaturas/:assinaturaId/produtos": { + response: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }; + /** @description Insere um endereço para um usuário pelo e-mail */ + "POST /usuarios/:email/enderecos": { + body: { + /** + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + */ + nomeEndereco?: string; + /** + * Nome da rua (Max Length: 500) + */ + rua?: string; + /** + * Número do local (Max Length: 50) + */ + numero?: string; + /** + * Complemento (Max Length: 250) (optional) + */ + complemento?: string; + /** + * Referência para a localização do endereço (Max Length: 500) (optional) + */ + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; + }; + }; + /** @description Atualiza o preço de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + "PUT /produtos/precos": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Lista com os dados da atualização do preço (optional) + */ + RAW_BODY: { + /** + * Identificador do produto (ProdutoVarianteId ou SKU) + */ + identificador?: string; + /** + * Preço de custo do produto variante + */ + precoCusto?: number; + /** + * "PrecoDe" do produto variante + */ + precoDe?: number; + /** + * "PrecoPor" do produto variante + */ + precoPor?: number; + /** + * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) + */ + fatorMultiplicadorPreco?: number; + }[]; + }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** @description Usuário encontrado */ + "GET /usuarios/email/:email": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** @description Novo token gerado com sucesso */ + "POST /autenticacao/trocarLoja/:novaLoja": { + response: { + lojas?: string[]; + accessToken?: string; + dataExpiracaoAccessTokenUTC?: string; + }; + }; + /** @description Remove um campo de cadastro personalizado */ + "DELETE /usuarios/camposcadastropersonalizado/:camposcadastropersonalizadoId": + {}; + /** @description Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente */ + "POST /eventos/:eventoId/produtos": { + body: { + /** + * Identificadores dos produtos variantes a serem vinculados ao evento desejado + */ + produtosVariante?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Campos de cadastro personalizado encontrados */ + "GET /usuarios/camposcadastropersonalizado": { + response: { + grupoInformacaoCadastralId?: number; + nome?: string; + tipo?: string; + obrigatorio?: boolean; + ordem?: number; + valorPreDefinido?: { + valoresDefinidosCampoGrupoInformacaoId?: number; + valor?: string; + ordem?: number; + }[]; + }[]; + }; + /** @description Atualiza os dados de um hotsite existente */ + "PUT /hotsites/:hotsiteId": { + body: { + /** + * Nome do hotsite + */ + nome?: string; + /** + * Data/hora em que o hotsite começará a ser exibido (optional) + */ + dataInicio?: string; + /** + * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) + */ + dataFinal?: string; + /** + * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início + */ + url?: string; + /** + * Informe o número de produtos que deve ser exibido por página + */ + tamanhoPagina?: number; + /** + * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates + */ + templateId?: number; + /** + * Informe qual será a ordenação dos Produtos no Hotsite (optional) + */ + ordenacao?: + | "Nenhuma" + | "NomeCrescente" + | "NomeDecrescente" + | "Lancamento" + | "MenorPreco" + | "MaiorPreco" + | "MaisVendidos" + | "MaioresDescontos" + | "Aleatorio" + | "MenorEstoque" + | "MaiorEstoque"; + /** + * Produtos que devem aparecer no hotsite + */ + listaProdutos?: { + /** + * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) + */ + expressao?: string; + /** + * Id dos produtos + */ + produtos?: { + /** + * Identificador do produto a ser mostrado no hotsite + */ + produtoId?: number; + /** + * Ordem para apresentação do produto (optional) + */ + ordem?: number; + }[]; + }; + /** + * Dados de seo + */ + seo?: { + /** + * Informe o Título que será exibido quando o Hotsite for acessado (optional) + */ + titulo?: string; + /** + * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) + */ + metas?: { + /** + * Informe os dados da Metatag + */ + conteudo?: string; + /** + * Informe os dados da Metatag + */ + nome?: string; + /** + * Informe os dados da Metatag + */ + httpEquiv?: string; + /** + * Informe os dados da Metatag + */ + scheme?: string; + }[]; + }; + /** + * Lista de identificadores de banners a serem vinculados ao hotsite + */ + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; + /** + * Lista de identificadores de conteúdos a serem vinculados ao hotsite + */ + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; + /** + * Status do hotsite (optional) + */ + ativo?: boolean; + }; + }; + /** @description Lista com assinaturas */ + "GET /assinaturas": { + searchParams: { + /** + * Situação da assinatura + */ + situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; + /** + * Período de recorrência + */ + periodoRecorrencia?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Data inicial da próxima recorrência + */ + dataInicialProximaRecorrencia?: string; + /** + * Data final da próxima recorrencia + */ + dataFinalProximaRecorrencia?: string; + /** + * Data inicial de cancelamento + */ + dataInicialCancelamento?: string; + /** + * Data final de cancelamento + */ + dataFinalCancelamento?: string; + }; + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + }[]; + }; + /** @description Lista de categorias */ + "GET /categorias": { + searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado apenas Reseller + */ + apenasReseller?: boolean; + /** + * Se será apresentado apenas o último nível das categorias + */ + apenasUltimoNivel?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }[]; + }; + /** @description Insere um novo fabricante */ + "POST /fabricantes": { + body: { + /** + * Nome do fabricante (optional) + */ + nome?: string; + /** + * URL tipo logo (optional) + */ + urlLogoTipo?: string; + /** + * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) + */ + urlLink?: string; + /** + * Insira nesse campo a URL do Carrossel da Marca (optional) + */ + urlCarrossel?: string; + }; + }; + /** @description Atualiza o campo Recebido de um produto vinculado a um evento */ + "PUT /eventos/:eventoId/produtos/recebido": { + body: { + /** + * Id do produto variante (optional) + */ + produtoVarianteId?: number; + /** + * Se o produto foi recebido fora da lista (optional) + */ + recebidoForaLista?: boolean; + }; + }; + /** @description Atualiza o tipo evento */ + "PUT /tiposEvento/:tipoEventoId": { + body: { + /** + * Nome do Tipo de Evento + */ + nome?: string; + /** + * Tipo de entrega + */ + tipoEntrega?: + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; + /** + * Disponibilização do Tipo de Evento + */ + tipoDisponibilizacao?: + | "DisponibilizacaoDeCreditos" + | "DisponibilizacaoDeProdutos" + | "Todos"; + /** + * Permissão para remoção automática de produtos + */ + permitirRemocaoAutomaticaProdutos?: boolean; + /** + * Cor em hexadecimal para o titulo de informações + */ + corHexTituloInformacoes?: string; + /** + * Cor em hexadecimal para o corpo de informações + */ + corHexCorpoInformacoes?: string; + /** + * Número de abas de informações, podendo ser de 1 a 2 + */ + numeroAbasInformacoes?: number; + /** + * Quantidade de dias para que o evento expire + */ + quantidadeDiasParaEventoExpirar?: number; + /** + * Quantidade de locais do evento + */ + numeroLocaisEvento?: number; + /** + * Informa se o evento está ativo ou inativo + */ + ativo?: boolean; + /** + * Informa a disponibilidade do evento + */ + disponivel?: boolean; + /** + * O beneficiário do frete + */ + tipoBeneficiarioFrete?: "DonodaLista" | "Convidado"; + /** + * Imagem da logo do evento em base64 + */ + imagemLogoEvento?: string; + /** + * Produtos Sugeridos para este evento (optional) + */ + sugestaoProdutos?: { + /** + * Id do tipo de evento + */ + tipoEventoId?: number; + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Produtos de uma assinatura */ + "GET /assinaturas/:email": { + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + produtos?: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }[]; + }; + /** @description Atualiza uma Loja Física */ + "PUT /lojasFisicas/:lojaFisicaId": { + body: { + /** + * Id da loja (optional) + */ + lojaId?: number; + /** + * Nome da loja (optional) + */ + nome?: string; + /** + * DDD da localidade de destino da loja (optional) + */ + ddd?: number; + /** + * Telefone da loja (optional) + */ + telefone?: string; + /** + * E-mail de contato da loja (optional) + */ + email?: string; + /** + * CEP do endereço da loja (optional) + */ + cep?: string; + /** + * Logradouro do endereço da loja (optional) + */ + logradouro?: string; + /** + * Número de localização do endereço da loja (optional) + */ + numero?: string; + /** + * Complemento para localização da loja (optional) + */ + complemento?: string; + /** + * Bairro do endereço do loja (optional) + */ + bairro?: string; + /** + * Cidade em que a loja se encontra (optional) + */ + cidade?: string; + /** + * Id do estado em que a loja se encontra (optional) + */ + estadoId?: number; + /** + * Prazo de entrega (optional) + */ + prazoEntrega?: number; + /** + * Prazo máximo para retirada (optional) + */ + prazoMaximoRetirada?: number; + /** + * Status da loja (optional) + */ + ativo?: boolean; + /** + * Valido (optional) + */ + valido?: boolean; + /** + * Informações complementares da loja (optional) + */ + textoComplementar?: string; + /** + * Se a retirada na loja será ativada (optional) + */ + retirarNaLoja?: boolean; + /** + * Latitude (optional) + */ + latitude?: number; + /** + * Longitude (optional) + */ + longitude?: number; + /** + * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) + */ + centroDistribuicao?: { + /** + * Id do centro de distribuição + */ + centroDistribuicaoId?: number; + /** + * Prazo de entrega + */ + prazoEntrega?: number; + }[]; + }; + }; + /** @description Atualiza um evento */ + "PUT /eventos/:eventoId": { + body: { + /** + * Identificador do tipo de evento + */ + tipoEventoId?: number; + /** + * Identificador do endereço de entrega + */ + enderecoEntregaId?: number; + /** + * Titulo do evento + */ + titulo?: string; + /** + * Atributo obsoleto - (optional) + */ + url?: string; + /** + * Data do Evento + */ + data?: string; + /** + * Email do usuário + */ + usuarioEmail?: string; + /** + * Disponibilidade do evento (optional) + */ + disponivel?: boolean; + /** + * Quantos dias antes do evento ele será exibido (optional) + */ + diasAntesEvento?: number; + /** + * Até quantos dias depois do evento ele será exibido (optional) + */ + diasDepoisEvento?: number; + /** + * Url do Logo. (Base64) + */ + urlLogo?: string; + /** + * Url da Capa. (Base64) + */ + urlCapa?: string; + /** + * Quem é o proprietário + */ + proprietario?: string; + /** + * Se a aba de informação 01 será habilitada + */ + abaInfo01Habilitado?: boolean; + /** + * Texto para o campo informação 01 (optional) + */ + textoInfo01?: string; + /** + * Conteúdo para o campo informação 01 (optional) + */ + conteudoInfo01?: string; + /** + * Se a aba de informação 02 será habilitada + */ + abaInfo02Habilitado?: boolean; + /** + * Texto para o campo informação 02 (optional) + */ + textoInfo02?: string; + /** + * Conteúdo para o campo informação 02 (optional) + */ + conteudoInfo02?: string; + /** + * Se a aba de mensagem será habilitada (optional) + */ + abaMensagemHabilitado?: boolean; + /** + * Tipo de lista de presente + */ + enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; + /** + * Tipo de entrega + */ + enumTipoEntregaId?: + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; + /** + * Seleção de produto no evento + */ + eventoProdutoSelecionado?: { + /** + * Id do produto variante + */ + produtoVarianteId?: number; + /** + * Se produto recebido fora da lista (optional) + */ + recebidoForaLista?: boolean; + /** + * Se produto removido (optional) + */ + removido?: boolean; + }[]; + /** + * Endereço do Evento + */ + enderecoEvento?: { + /** + * Nome para identificação do endereço + */ + nome?: string; + /** + * Endereço + */ + endereco?: string; + /** + * Cep do endereço + */ + cep?: string; + /** + * Numero do endereço + */ + numero?: string; + /** + * Bairro do endereço + */ + bairro?: string; + /** + * Cidade do endereço + */ + cidade?: string; + /** + * Estado do endereço + */ + estado?: string; + }[]; + }; + }; + /** @description Lista de identificadores de banners vinculados ao hotsite */ + "GET /hotsites/:hotsiteId/banners": { + response: { + bannerId?: number; + }[]; + }; + /** @description Atualiza a comunicação de um usuário via newsletter */ + "PUT /usuarios/:email/comunicacao": { + body: { + /** + * Novo status da comunicação via new ajuste realisletter + */ + recebimentoNewsletter?: boolean; + }; + }; + /** @description Insere uma nova categoria */ + "POST /categorias": { + body: { + /** + * Nome da categoria (optional) + */ + nome?: string; + /** + * Id da categoria pai (optional) + */ + categoriaPaiId?: number; + /** + * Id da categoria ERP (optional) + */ + categoriaERPId?: string; + /** + * Categoria ativo/inativo (optional) + */ + ativo?: boolean; + /** + * Categoria de reseller (optional) + */ + isReseller?: boolean; + /** + * Exibir Matriz de Atributos (optional) + */ + exibirMatrizAtributos?: "Sim" | "Nao" | "Neutro"; + /** + * Informe a quantidade máxima permitida para compra por produtos desta categoria. Informe zero para assumir a configuração geral da loja (optional) + */ + quantidadeMaximaCompraUnidade?: number; + /** + * Informe o valor mínimo para compra em produtos desta categoria (optional) + */ + valorMinimoCompra?: number; + /** + * Informe se será exibida no menu (optional) + */ + exibeMenu?: boolean; + }; + }; + /** @description Estorna um valor menor ou igual ao total do pedido "Pago" */ + "POST /pedidos/estorno/:pedidoId": { + body: { + /** + * Valor a ser estornado do pedido. Total ou parcial. + */ + Valor?: number; + }; + }; + /** @description Pedidos que terão vínculo com o grupo de assinatura informado. */ + "POST /assinaturas/grupoassinatura/assinatura": { + body: { + /** + * Lista de pedidos a serem vinculados a assinatura + */ + pedidos?: { + /** + * Id do pedido + */ + pedidoId?: number; + }[]; + /** + * ID da recorrência vinculada ao grupo, disponível em GET /assinaturas/grupoassinatura + */ + recorrenciaId?: number; + /** + * ID do grupo de assinatura, disponível em GET /assinaturas/grupoassinatura + */ + grupoAssinaturaId?: number; + }; + }; + /** @description Lista de hotsites vinculados ao banner */ + "GET /banners/:bannerId/hotsites": { + response: { + exibirEmTodosHotSites?: boolean; + hotSites?: { + hotSiteId?: number; + }[]; + }; + }; + /** @description Lista de situações de pedido */ + "GET /situacoesPedido": { + response: { + situacaoPedidoId?: number; + nome?: string; + descricao?: string; + observacao?: string; + }[]; + }; + /** @description Insere uma Loja Física */ + "POST /lojasFisicas": { + body: { + /** + * Id da loja (optional) + */ + lojaId?: number; + /** + * Nome da loja (optional) + */ + nome?: string; + /** + * DDD da localidade de destino da loja (optional) + */ + ddd?: number; + /** + * Telefone da loja (optional) + */ + telefone?: string; + /** + * E-mail de contato da loja (optional) + */ + email?: string; + /** + * CEP do endereço da loja (optional) + */ + cep?: string; + /** + * Logradouro do endereço da loja (optional) + */ + logradouro?: string; + /** + * Número de localização do endereço da loja (optional) + */ + numero?: string; + /** + * Complemento para localização da loja (optional) + */ + complemento?: string; + /** + * Bairro do endereço do loja (optional) + */ + bairro?: string; + /** + * Cidade em que a loja se encontra (optional) + */ + cidade?: string; + /** + * Id do estado em que a loja se encontra (optional) + */ + estadoId?: number; + /** + * Prazo de entrega (optional) + */ + prazoEntrega?: number; + /** + * Prazo máximo para retirada (optional) + */ + prazoMaximoRetirada?: number; + /** + * Status da loja (optional) + */ + ativo?: boolean; + /** + * Valido (optional) + */ + valido?: boolean; + /** + * Informações complementares da loja (optional) + */ + textoComplementar?: string; + /** + * Se a retirada na loja será ativada (optional) + */ + retirarNaLoja?: boolean; + /** + * Latitude (optional) + */ + latitude?: number; + /** + * Longitude (optional) + */ + longitude?: number; + /** + * Lista com os Identificadores dos centros de distribuição que serão vinculados a loja física (optional) + */ + centroDistribuicao?: { + /** + * Id do centro de distribuição + */ + centroDistribuicaoId?: number; + /** + * Prazo de entrega + */ + prazoEntrega?: number; + }[]; + }; + }; + /** @description Atualiza um usuário pelo email */ + "PUT /usuarios/:email": { + body: { + /** + * Tipo de pessoa + */ + tipoPessoa?: "Fisica" | "Juridica"; + /** + * Origem do contato + */ + origemContato?: + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; + /** + * Tipo Sexo (optional) + */ + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; + /** + * Nome do usuário (Max Length: 100) + */ + nome?: string; + /** + * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + cpf?: string; + /** + * E-mail do usuário (Max Length: 100) + */ + email?: string; + /** + * RG do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + rg?: string; + /** + * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) + */ + telefoneResidencial?: string; + /** + * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) + */ + telefoneCelular?: string; + /** + * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) + */ + telefoneComercial?: string; + /** + * Data de nascimento (optional) + */ + dataNascimento?: string; + /** + * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) + */ + razaoSocial?: string; + /** + * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + cnpj?: string; + /** + * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + inscricaoEstadual?: string; + /** + * Responsável(Max Length: 100) (optional) + */ + responsavel?: string; + /** + * Data de criação do cadastro (optional) + */ + dataCriacao?: string; + /** + * Data de atualização do cadastro (optional) + */ + dataAtualizacao?: string; + /** + * Se o usuário é revendedor (optional) + */ + revendedor?: boolean; + /** + * Informação cadastral (optional) + */ + listaInformacaoCadastral?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; + /** + * Avatar (Max Length: 50) (optional) + */ + avatar?: string; + /** + * IP do usuário (Max Length: 20) (optional) + */ + ip?: string; + /** + * Seta ou retorna o valor de Aprovado (optional) + */ + aprovado?: boolean; + }; + }; + /** @description Insere um novo campo de cadastro personalizado */ + "POST /usuarios/CadastroPersonalizado": { + body: { + /** + * Nome do campo + */ + nome?: string; + /** + * Tipo do campo + */ + tipo?: "TextoLivre" | "ValoresPredefinidos" | "RadioButton"; + /** + * Se o campo será obrigatório + */ + obrigatorio?: boolean; + /** + * Ordem + */ + ordem?: number; + /** + * Informação para os campos (optional) + */ + valorPreDefinido?: { + /** + * Valor + */ + valor?: string; + /** + * Ordem + */ + ordem?: number; + }[]; + }; + }; + /** @description Seta identificador como variante principal */ + "PUT /produtos/:identificador/principal": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Insere uma inscrição */ + "POST /webhook/inscricao": { + body: { + /** + * Nome da inscrição + */ + nome?: string; + /** + * Url para qual deve ser enviada as notificações + */ + appUrl?: string; + /** + * Tópicos em que deseja se inscrever + */ + topicos: string[]; + /** + * Usuário que está realizando a inscrição + */ + usuario?: string; + /** + * Status da inscrição, se ativada ou desativada + */ + ativo?: boolean; + /** + * E-mail do responsável para notificá-lo quando não seja possível notificá-lo pelo AppUrl informado + */ + emailResponsavel?: string; + /** + * Headers que devam ser adicionados ao realizar a requisição para o AppUrl. Headers de Conteúdo como 'ContentType' não são necessário. As requisições realizada sempre serão no formato 'application/json' (optional) + */ + headers?: { + /** + * Chave do header, por exemplo: 'Authorization' + */ + chave?: string; + /** + * Valor / Conteúdo do header, por exemplo: 'Basic 0G3EQWD-W324F-234SD-2421OFSD' + */ + valor?: string; + }[]; + }; + }; + /** @description Lista de produtos de um Grupo de Personalização */ + "GET /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { + response: { + produtoId?: number; + nome?: string; + alias?: string; + }[]; + }; + /** @description Lista de inscrições */ + "GET /webhook/inscricao": { + response: { + inscricaoId?: number; + nome?: string; + appUrl?: string; + ativo?: boolean; + emailResponsavel?: string; + topico?: string[]; + usuario?: string; + header?: { + headerId?: number; + chave?: string; + valor?: string; + }[]; + }[]; + }; + /** @description Gráfico do Faturamento */ + "GET /dashboard/graficofaturamento": { + searchParams: { + /** + * Data inicial do faturamento que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final do faturamento que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Se o faturamento é somente da loja + */ + isLoja?: number; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + parceiroId?: number; + parceiro?: string; + receitaPagos?: number; + transacoesPagos?: number; + valorMedioPagos?: number; + usuarioEnderecoEstado?: string; + }[]; + }; + /** @description Exclui uma informação de um produto */ + "DELETE /produtos/:identificador/informacoes/:informacaoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + }; + /** @description Assinatura de um determinado pedido */ + "GET /assinaturas/pedido/:pedidoId": { + response: { + assinaturaPedidoId?: number; + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + pedidoId?: number; + valor?: number; + data?: string; + origemPedidoEnumId?: number; + produtoVarianteId?: number; + }[]; + }; + /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId/parcial": { + body: { + /** + * Objeto Pedido Rastreamento + */ + RAW_BODY: { + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de Rastreamento (optional) + */ + urlRastreamento?: string; + }; + }; + }; + /** @description Inseri uma lista de produto variantes em uma tabela de preços */ + "POST /tabelaPrecos/:tabelaPrecoId/produtos": { + body: { + /** + * Lista de produtos variantes + */ + RAW_BODY: { + /** + * SKU do produto + */ + sku?: string; + /** + * Preço De do produto + */ + precoDe?: number; + /** + * Preço Por do produto + */ + precoPor?: number; + }[]; + }; + response: { + sucesso?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + erro?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** @description Access token atualizado com sucesso */ + "POST /autenticacao/refresh": { + response: { + lojas?: string[]; + accessToken?: string; + dataExpiracaoAccessTokenUTC?: string; + }; + }; + /** @description Ativa ou inativa uma inscrição */ + "PUT /webhook/inscricao/:inscricaoId/Ativar": { + body: { + /** + * Status que deseja atualizar a inscrição. True (Ativada) ou False (desativada) + */ + ativo?: boolean; + /** + * Usuário que está realizando a atualização + */ + usuario?: string; + /** + * Observação que deseje fazer com relação a ativação/desativação da inscrição (optional) + */ + observacao?: string; + }; + }; + /** @description Assinatura com erro na loja */ + "GET /assinaturas/erros/:assinaturaId": { + response: { + assinaturaErroId?: number; + assinaturaId?: number; + usuarioId?: string; + visualizado?: boolean; + dataErro?: string; + resolvido?: boolean; + codigoAssinaturaErro?: number; + assinaturaErroNome?: string; + assinaturaErroDescricao?: string; + }[]; + }; + /** @description Limite de crédito de um usuário específico */ + "GET /usuarios/limiteCreditoPorEmail/:email": { + response: { + usuarioId?: number; + valor?: number; + saldo?: number; + }; + }; + /** @description Retorna o histórico de situações de um pedido */ + "GET /pedidos/:pedidoId/historicoSituacao": { + response: { + situacoes?: { + situacaoPedidoId?: number; + nome?: string; + dataAtualizacao?: string; + }[]; + }; + }; + /** @description SEO do produto informado */ + "GET /produtos/:identificador/seo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + response: { + tagCanonical?: string; + title?: string; + metatags?: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; + }; + }; + /** @description Atualiza o limite de crédito para um usuário */ + "PUT /usuarios/limiteCredito/:usuarioId": { + searchParams: { + /** + * CPF ou CNPJ do usuário + */ + cpf_cnpj?: string; + /** + * Valor do limite de crédito + */ + valor?: number; + }; + }; + /** @description Exclui uma categoria */ + "DELETE /categorias/:id": {}; + /** @description Retorna a lista de produtos de um portfolio */ + "GET /portfolios/:portfolioId/produtos": { + response: { + produtoId?: number; + }[]; + }; + /** @description Insere um rastreamento e status a um produto variante */ + "POST /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento": { + body: { + /** + * Id da situação do pedido + */ + situacaoPedidoId?: number; + /** + * Quantidade (optional) + */ + quantidade?: number; + /** + * Id do centro de distribuição + */ + centroDistribuicaoId?: number; + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * Data (optional) + */ + dataEvento?: string; + /** + * Número da nota fiscal (optional) + */ + numeroNotaFiscal?: string; + /** + * Chave de acesso NFE (optional) + */ + chaveAcessoNFE?: string; + /** + * URL NFE (optional) + */ + urlNFE?: string; + /** + * Serie NFE (optional) + */ + serieNFE?: string; + /** + * CFOP (optional) + */ + cfop?: number; + /** + * URL de rastreamento (optional) + */ + urlRastreamento?: string; + }; + }; + /** @description Lista de resposta para cada produto vinculado */ + "POST /tiposEvento/:tipoEventoId/produtos": { + body: { + /** + * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado + */ + produtos?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + response: { + sugestaoProdutosInseridos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + detalhes?: string; + }[]; + produtosNaoInseridos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + detalhes?: string; + }[]; + }; + }; + /** @description Desvincula um ou mais banners de um hotsite específico */ + "DELETE /hotsites/:hotsiteId/banners": { + body: { + /** + * Lista de identificadores de banners a serem desvinculados + */ + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; + }; + }; + /** @description Lista de produtos variantes vinculados aos tipo de evento */ + "GET /eventos/:eventoId": { + response: { + eventoId?: number; + tipoEventoId?: number; + userId?: number; + enderecoEntregaId?: number; + data?: string; + dataCriacao?: string; + titulo?: string; + url?: string; + disponivel?: boolean; + diasDepoisEvento?: number; + diasAntesEvento?: number; + urlLogoEvento?: string; + urlCapaEvento?: string; + proprietarioEvento?: string; + abaInfo01Habilitado?: boolean; + textoInfo01?: string; + conteudoInfo01?: string; + abaInfo02Habilitado?: boolean; + textoInfo02?: string; + conteudoInfo02?: string; + abaMensagemHabilitado?: boolean; + fotos?: string; + enumTipoListaPresenteId?: string; + enumTipoEntregaId?: string; + eventoProdutoSelecionado?: { + eventoId?: number; + produtoVarianteId?: number; + recebidoForaLista?: boolean; + removido?: boolean; + }[]; + enderecoEvento?: { + enderecoEventoId?: number; + eventoId?: number; + nome?: string; + cep?: string; + endereco?: string; + numero?: string; + bairro?: string; + cidade?: string; + estado?: string; + }[]; + }[]; + }; + /** @description Usuários encontrados */ + "GET /parceiros/:parceiroId/usuarios": { + response: { + usuarioId?: number; + email?: string; + ativo?: boolean; + dataInicial?: string; + dataFinal?: string; + vinculoVitalicio?: boolean; + }[]; + }; + /** @description Atualiza a data de entrega do pedido */ + "PUT /pedidos/:pedidoId/rastreamento": { + body: { + /** + * Objeto com os dados do rastreamento + */ + RAW_BODY: { + /** + * Código de verificação do transporte do produto + */ + rastreamento?: string; + /** + * Data que a entrega foi realizada + */ + dataEntrega?: string; + }; + }; + }; + /** @description Atualiza um fabricante */ + "PUT /fabricantes/:fabricanteId": { + body: { + /** + * Nome do fabricante (optional) + */ + nome?: string; + /** + * URL tipo logo (optional) + */ + urlLogoTipo?: string; + /** + * Insira neste campo uma URL para redirecionamento. A URL deve ser inserida por completa (optional) + */ + urlLink?: string; + /** + * Insira nesse campo a URL do Carrossel da Marca (optional) + */ + urlCarrossel?: string; + }; + }; + /** @description Dados de transação do pedido */ + "GET /pedidos/transacoes/:transacaoId": {}; + /** @description Operação realizada com ou sem sucesso para os usuários */ + "PUT /usuarios/autorizar": { + searchParams: { + /** + * Tipo de Identificador + */ + tipoIdentificador?: "UsuarioId" | "Email"; + }; + body: { + /** + * Usuários + */ + RAW_BODY?: { + /** + * Identificador + */ + identificador?: string; + /** + * Status de aprovação + */ + aprovado?: boolean; + }[]; + }; + response: { + usuariosAtualizados?: string[]; + usuariosNaoAtualizados?: string[]; + }; + }; + /** @description Cria um Novo Evento */ + "POST /eventos": { + body: { + /** + * Identificador do tipo de evento + */ + tipoEventoId?: number; + /** + * Identificador do endereço de entrega + */ + enderecoEntregaId?: number; + /** + * Titulo do evento + */ + titulo?: string; + /** + * URL do evento + */ + url?: string; + /** + * Data do Evento + */ + data?: string; + /** + * Email do usuário + */ + usuarioEmail?: string; + /** + * Disponibilidade do evento (optional) + */ + disponivel?: boolean; + /** + * Quantos dias antes do evento ele será exibido (optional) + */ + diasAntesEvento?: number; + /** + * Até quantos dias depois do evento ele será exibido (optional) + */ + diasDepoisEvento?: number; + /** + * Url do Logo. (Base64) + */ + urlLogo?: string; + /** + * Url da Capa. (Base64) + */ + urlCapa?: string; + /** + * Quem é o proprietário + */ + proprietario?: string; + /** + * Se a aba de informação 01 será habilitada + */ + abaInfo01Habilitado?: boolean; + /** + * Texto para o campo informação 01 (optional) + */ + textoInfo01?: string; + /** + * Conteúdo para o campo informação 01 (optional) + */ + conteudoInfo01?: string; + /** + * Se a aba de informação 02 será habilitada + */ + abaInfo02Habilitado?: boolean; + /** + * Texto para o campo informação 02 (optional) + */ + textoInfo02?: string; + /** + * Conteúdo para o campo informação 02 (optional) + */ + conteudoInfo02?: string; + /** + * Se a aba de mensagem será habilitada (optional) + */ + abaMensagemHabilitado?: boolean; + /** + * Tipo de lista de presente + */ + enumTipoListaPresenteId?: "ListaPronta" | "ListaManual"; + /** + * Tipo de entrega + */ + enumTipoEntregaId?: + | "EntregaAgendada" + | "EntregaConformeCompraRealizada" + | "Todos" + | "Nenhum"; + /** + * Seleção de produto no evento + */ + eventoProdutoSelecionado?: { + /** + * Id do produto variante + */ + produtoVarianteId?: number; + /** + * Se produto recebido fora da lista (optional) + */ + recebidoForaLista?: boolean; + /** + * Se produto removido (optional) + */ + removido?: boolean; + }[]; + /** + * Endereço do Evento + */ + enderecoEvento?: { + /** + * Nome para identificação do endereço + */ + nome?: string; + /** + * Endereço + */ + endereco?: string; + /** + * Cep do endereço + */ + cep?: string; + /** + * Numero do endereço + */ + numero?: string; + /** + * Bairro do endereço + */ + bairro?: string; + /** + * Cidade do endereço + */ + cidade?: string; + /** + * Estado do endereço + */ + estado?: string; + }[]; + }; + }; + /** @description Atualiza a data de cadastro um produto com base nos dados enviados */ + "PUT /produtos/:identificador/DataCadastro": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Data de cadastro de um produto - Formato: aaaa-mm-dd hh:mm:ss + */ + dataCadastro?: string; + }; + response: { + produtoVarianteId?: number; + produtoId?: number; + idPaiExterno?: string; + idVinculoExterno?: string; + sku?: string; + nome?: string; + nomeProdutoPai?: string; + urlProduto?: string; + exibirMatrizAtributos?: string; + contraProposta?: boolean; + fabricante?: string; + autor?: string; + editora?: string; + colecao?: string; + genero?: string; + precoCusto?: number; + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + prazoEntrega?: number; + valido?: boolean; + exibirSite?: boolean; + freteGratis?: string; + trocaGratis?: boolean; + peso?: number; + altura?: number; + comprimento?: number; + largura?: number; + garantia?: number; + isTelevendas?: boolean; + ean?: string; + localizacaoEstoque?: string; + listaAtacado?: { + precoPor?: number; + quantidade?: number; + }[]; + estoque?: { + estoqueFisico?: number; + estoqueReservado?: number; + centroDistribuicaoId?: number; + alertaEstoque?: number; + }[]; + atributos?: { + tipoAtributo?: string; + isFiltro?: boolean; + nome?: string; + valor?: string; + exibir?: boolean; + }[]; + quantidadeMaximaCompraUnidade?: number; + quantidadeMinimaCompraUnidade?: number; + condicao?: string; + informacoes?: { + informacaoId?: number; + titulo?: string; + texto?: string; + tipoInformacao?: string; + }[]; + tabelasPreco?: { + tabelaPrecoId?: number; + nome?: string; + precoDe?: number; + precoPor?: number; + }[]; + dataCriacao?: string; + dataAtualizacao?: string; + urlVideo?: string; + spot?: boolean; + paginaProduto?: boolean; + marketplace?: boolean; + somenteParceiros?: boolean; + reseller?: { + resellerId?: number; + razaoSocial?: string; + centroDistribuicaoId?: number; + ativo?: boolean; + ativacaoAutomaticaProdutos?: boolean; + autonomia?: boolean; + buyBox?: boolean; + nomeMarketPlace?: string; + }; + buyBox?: boolean; + }; + }; + /** @description Insere um novo Seller no marketplace */ + "POST /resellers": { + body: { + /** + * Razão Social/Nome do Reseller + */ + razaoSocial?: string; + /** + * CNPJ do Seller + */ + cnpj?: string; + /** + * Inscrição Estadual do Seller + */ + inscricaoEstadual?: string; + /** + * Seller isento de inscrição estadual + */ + isento?: boolean; + /** + * Email de contato do Seller + */ + email?: string; + /** + * Telefone de contato do seller com ddd (xx) xxxx-xxxx + */ + telefone?: string; + /** + * Tipo de autonomia do vendedor + */ + tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; + /** + * Seller Ativo + */ + ativo?: boolean; + /** + * Se irá ter Split de frete boolean. Default:false + */ + split?: boolean; + /** + * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, + */ + buyBox?: boolean; + /** + * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, + */ + ativacaoAutomaticaProdutos?: boolean; + /** + * Cep do Seller (utilizado para o calculo de frete) + */ + cep?: string; + }; + }; + /** @description Atualiza a situação do status de um produto do pedido */ + "PUT /pedidos/:pedidoId/:produtoVarianteId/status": { + body: { + /** + * Dados da situação do produto (optional) + */ + RAW_BODY: { + /** + * Id do centro de distribuição do produto + */ + centroDistribuicaoId?: number; + /** + * Quantidade de produtos do centro de distribuição + */ + quantidade?: number; + /** + * Novo status da situação do produto (são os mesmo status do pedido) + */ + situacaoPedidoProdutoId?: number; + }; + }; + }; + /** @description Lista de Lojas Físicas */ + "GET /lojasFisicas": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + lojaId?: number; + nome?: string; + ddd?: number; + telefone?: string; + email?: string; + cep?: string; + logradouro?: string; + numero?: string; + complemento?: string; + bairro?: string; + cidade?: string; + estadoId?: number; + prazoEntrega?: number; + prazoMaximoRetirada?: number; + ativo?: boolean; + valido?: boolean; + textoComplementar?: string; + retirarNaLoja?: boolean; + latitude?: number; + longitude?: number; + centroDistribuicaoId?: number; + centroDistribuicao?: { + centroDistribuicaoId?: number; + prazoEntrega?: number; + }[]; + }[]; + }; + /** @description Atualiza os produtos sugeridos de um tipo de evento */ + "PUT /tiposEvento/:tipoEventoId/produtos": { + body: { + /** + * Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado + */ + produtos?: { + /** + * Identificador do produto variante + */ + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Indicadores dos Produtos no Estoque */ + "GET /dashboard/produtoestoque": { + searchParams: { + /** + * Data inicial dos produtos no estoque que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos produtos no estoque que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + indicadorProdutoComEstoque?: string; + indicadorProdutoSemEstoque?: string; + }; + }; + /** @description Atualiza um endereço de um usuário pelo e-mail do usuário */ + "PUT /usuarios/:email/enderecos/:enderecoId": { + body: { + /** + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + */ + nomeEndereco?: string; + /** + * Nome da rua (Max Length: 500) + */ + rua?: string; + /** + * Número do local (Max Length: 50) + */ + numero?: string; + /** + * Complemento (Max Length: 250) (optional) + */ + complemento?: string; + /** + * Referência para a localização do endereço (Max Length: 500) (optional) + */ + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; + }; + }; + /** @description Deleta um atributo */ + "DELETE /atributos/:nome": {}; + /** @description Parceiro excluído com sucesso */ + "DELETE /parceiros/:parceiroId": { + response: { + resultadoOperacao?: boolean; + codigo?: number; + mensagem?: string; + }; + }; + /** @description Atualiza o status de uma avaliação de um produto variante */ + "PUT /produtoavaliacao/:produtoAvaliacaoId/status": { + body: { + /** + * Status para a avaliação + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + }; + }; + /** @description Insere um rastreamento e status a um pedido */ + "POST /pedidos/:pedidoId/rastreamento": { + body: { + /** + * Id da situação do pedido + */ + situacaoPedidoId?: number; + /** + * Id do centro de distribuição + */ + centroDistribuicaoId?: number; + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * Data do pedido (optional) + */ + dataEvento?: string; + /** + * Número da nota fiscal (optional) + */ + numeroNotaFiscal?: string; + /** + * Chave acesso NFE (optional) + */ + chaveAcessoNFE?: string; + /** + * URL NFE (optional) + */ + urlNFE?: string; + /** + * Serie NFE (optional) + */ + serieNFE?: string; + /** + * CFOP (optional) + */ + cfop?: string; + /** + * URL Rastreamento (optional) + */ + urlRastreamento?: string; + }; + }; + /** @description Fabricante encontrado */ + "GET /fabricantes/:nome": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; + }; + }; + /** @description Vincula parceiros com um banner específico */ + "POST /banners/:bannerId/parceiros": { + body: { + /** + * Lista de Id dos parceiros + */ + RAW_BODY: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + }[]; + }; + }; + /** @description Lista de tabelas de preços */ + "GET /tabelaPrecos": { + response: { + tabelaPrecoId?: number; + nome?: string; + dataInicial?: string; + dataFinal?: string; + ativo?: boolean; + isSite?: boolean; + }[]; + }; + /** @description Atualiza a imagem do banner */ + "PUT /banners/:bannerId/Imagem": { + body: { + /** + * URL da Imagem (optional) + */ + urlImagem?: string; + /** + * Informações para atualizar a imagem (optional) + */ + Imagem?: { + /** + * string da imagem em base 64 + */ + base64?: string; + /** + * formato da imagem + */ + formato?: "PNG" | "JPG" | "JPEG"; + /** + * nome da imagem + */ + nome?: string; + }; + }; + }; + /** @description Atualiza um conteúdo */ + "PUT /conteudos/:conteudoId": { + body: { + /** + * Titulo do conteúdo + */ + titulo?: string; + /** + * Conteúdo ativo/inativo + */ + ativo?: boolean; + /** + * Data de inicio de exibição do conteúdo (optional) + */ + dataInicio?: string; + /** + * Data de final de exibição do conteúdo (optional) + */ + dataFim?: string; + /** + * Posicionamento do conteúdo + */ + posicionamento?: + | "Topo" + | "Centro" + | "Rodape" + | "LateralDireita" + | "LateralEsquerda" + | "MobileTopo" + | "MobileRodape"; + /** + * Informações do conteúdo + */ + conteudo?: string; + /** + * Insira em qual Termo de Busca o Conteúdo será exibido (optional) + */ + termoBusca?: string; + /** + * Exibição do conteúdo nas buscas + */ + exibeTodasBuscas?: boolean; + /** + * Não exibição do conteúdo nas buscas + */ + naoExibeBuscas?: boolean; + /** + * Exibição do conteúdo nos hotsites + */ + exibeTodosHotsites?: boolean; + /** + * Insira quais Hotsites que o Conteúdo será exibido (optional) + */ + hotsiteId?: number[]; + }; + }; + /** @description Categoria encontrada */ + "GET /categorias/erp/:id": { + searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }; + }; + /** @description Lista de Ranges de Ceps de uma Loja Física */ + "GET /lojasFisicas/:lojaFisicaId/rangeCep": { + response: { + rangeCepId?: number; + nome?: string; + cepInicial?: string; + cepFinal?: string; + }[]; + }; + /** @description Atualiza um Atacarejo */ + "PUT /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Preço atacado (optional) + */ + precoAtacado?: number; + /** + * Quantidade do produto (optional) + */ + quantidade?: number; + }; + }; + /** @description Exclui o vínculo entre uma categoria e um produto */ + "DELETE /produtos/:identificador/categorias/:id": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + }; + /** @description Xml com os dados de uma mídia específicas entre duas datas */ + "GET /midias/:identificador": { + searchParams: { + /** + * Data inicial (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final (aaaa-mm-dd) + */ + dataFinal?: string; + }; + response: { + dias?: { + diaMidiaApiModel?: { + dia?: string; + investimento?: { + meta?: number; + realizado?: number; + }; + pedidos?: { + meta?: number; + realizado?: number; + }; + roi?: { + meta?: number; + realizado?: number; + }; + receita?: { + meta?: number; + realizado?: number; + }; + visitas?: { + meta?: number; + realizado?: number; + }; + }[]; + }; + id?: number; + nome?: string; + tipo?: string; + }; + }; + /** @description A lista de produtos para serem exibidos no hotsite está limitada a 1024 itens, tanto por expressão como por produtos. */ + "POST /hotsites": { + body: { + /** + * Nome do hotsite + */ + nome?: string; + /** + * Data/hora em que o hotsite começará a ser exibido (optional) + */ + dataInicio?: string; + /** + * Data/Hora (último dia) em que o hotsite não será mais exibido (optional) + */ + dataFinal?: string; + /** + * Informe a url do hotsite. Por exemplo, se o site for 'busca.meusite.com.br', e o hotsite desejado for 'busca.meusite.com.br/hotsite/natal' informe neste campo somente a url 'hotsite/natal', sem a barra '/' no início + */ + url?: string; + /** + * Informe o número de produtos que deve ser exibido por página + */ + tamanhoPagina?: number; + /** + * Informe o identificador do template que será utilizado. Caso não saiba o identificador do template desejado, o mesmo pode ser buscado no endpoint GET/Templates + */ + templateId?: number; + /** + * Informe qual será a ordenação dos Produtos no Hotsite (optional) + */ + ordenacao?: + | "Nenhuma" + | "NomeCrescente" + | "NomeDecrescente" + | "Lancamento" + | "MenorPreco" + | "MaiorPreco" + | "MaisVendidos" + | "MaioresDescontos" + | "Aleatorio" + | "MenorEstoque" + | "MaiorEstoque"; + /** + * Produtos que devem aparecer no hotsite + */ + listaProdutos?: { + /** + * você pode utilizar essa opção para gerar um hotsite utilizando uma expressão de busca. Ao utilizá-la, os produtos adicionados nos outros modos de criação de hotsite serão ignorados (optional) + */ + expressao?: string; + /** + * Id dos produtos + */ + produtos?: { + /** + * Identificador do produto a ser mostrado no hotsite + */ + produtoId?: number; + /** + * Ordem para apresentação do produto (optional) + */ + ordem?: number; + }[]; + }; + /** + * Dados de seo (optional) + */ + seo?: { + /** + * Informe o Título que será exibido quando o Hotsite for acessado (optional) + */ + titulo?: string; + /** + * Não se esqueça! Além do texto livre, você pode utilizar as tags [Nome.Hotsite] e [Fbits.NomeLoja] para o cadastro das MetaTags e Title! (optional) + */ + metas?: { + /** + * Informe os dados da Metatag + */ + conteudo?: string; + /** + * Informe os dados da Metatag + */ + nome?: string; + /** + * Informe os dados da Metatag + */ + httpEquiv?: string; + /** + * Informe os dados da Metatag + */ + scheme?: string; + }[]; + }; + /** + * Lista de identificadores de banners a serem vinculados ao hotsite (optional) + */ + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; + /** + * Lista de identificadores de conteúdos a serem vinculados ao hotsite + */ + conteudos?: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; + /** + * Status do hotsite (optional) + */ + ativo?: boolean; + }; + }; + /** @description Lista de pedidos */ + "GET /pedidos/situacaoPedido/:situacoesPedido": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Tipo de filtro da data (Ordenação "desc" - padrão: DataPedido) + */ + enumTipoFiltroData?: + | "DataPedido" + | "DataAprovacao" + | "DataModificacaoStatus" + | "DataAlteracao" + | "DataCriacao"; + /** + * Lista de formas de pagamento que deverão retornar (lista separada por "," ex.: 1,2,3), caso vazio retornará todas as formas de pagamento + */ + formasPagamento?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + /** + * Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos. + */ + apenasAssinaturas?: boolean; + }; + response: { + pedidoId?: number; + situacaoPedidoId?: number; + tipoRastreamentoPedido?: string; + transacaoId?: number; + data?: string; + dataPagamento?: string; + dataUltimaAtualizacao?: string; + valorFrete?: number; + valorTotalPedido?: number; + valorDesconto?: number; + valorDebitoCC?: number; + cupomDesconto?: string; + marketPlacePedidoId?: string; + marketPlacePedidoSiteId?: string; + canalId?: number; + canalNome?: string; + canalOrigem?: string; + retiradaLojaId?: number; + isPedidoEvento?: boolean; + usuario?: { + usuarioId?: number; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + }; + pedidoEndereco?: { + tipo?: string; + nome?: string; + endereco?: string; + numero?: string; + complemento?: string; + referencia?: string; + cep?: string; + tipoLogradouro?: string; + logradouro?: string; + bairro?: string; + cidade?: string; + estado?: string; + pais?: string; + }[]; + frete?: { + freteContratoId?: number; + freteContrato?: string; + referenciaConector?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + retiradaLojaId?: number; + centrosDistribuicao?: { + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + servico?: { + servicoId?: number; + nome?: string; + transportadora?: string; + prazo?: number; + servicoNome?: string; + preco?: number; + servicoTransporte?: number; + codigo?: number; + servicoMeta?: string; + custo?: number; + token?: string; + }; + retiradaAgendada?: { + lojaId?: number; + retiradaData?: string; + retiradaPeriodo?: string; + nome?: string; + documento?: string; + codigoRetirada?: string; + }; + agendamento?: { + de?: string; + ate?: string; + }; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }; + itens?: { + produtoVarianteId?: number; + sku?: string; + nome?: string; + quantidade?: number; + precoCusto?: number; + precoVenda?: number; + isBrinde?: boolean; + valorAliquota?: number; + isMarketPlace?: boolean; + precoPor?: number; + desconto?: number; + totais?: { + precoCusto?: number; + precoVenda?: number; + precoPor?: number; + desconto?: number; + }; + ajustes?: { + tipo?: string; + valor?: number; + observacao?: string; + nome?: string; + }[]; + centroDistribuicao?: { + centroDistribuicaoId?: number; + quantidade?: number; + situacaoProdutoId?: number; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + }[]; + valoresAdicionais?: { + tipo?: string; + origem?: string; + texto?: string; + valor?: number; + }[]; + atributos?: { + produtoVarianteAtributoValor?: string; + produtoVarianteAtributoNome?: string; + }[]; + embalagens?: { + tipoEmbalagemId?: number; + nomeTipoEmbalagem?: string; + mensagem?: string; + valor?: number; + descricao?: string; + }[]; + personalizacoes?: { + nomePersonalizacao?: string; + valorPersonalizacao?: string; + valor?: number; + }[]; + frete?: { + quantidade?: number; + freteContratoId?: number; + freteContrato?: string; + valorFreteEmpresa?: number; + valorFreteCliente?: number; + peso?: number; + pesoCobrado?: number; + volume?: number; + volumeCobrado?: number; + prazoEnvio?: number; + prazoEnvioTexto?: string; + centroDistribuicaoId?: number; + }[]; + dadosProdutoEvento?: { + tipoPresenteRecebimento?: string; + }; + formulas?: { + chaveAjuste?: string; + valor?: number; + nome?: string; + expressao?: string; + expressaoInterpretada?: string; + endPoint?: string; + }[]; + seller?: { + sellerId?: number; + sellerNome?: string; + sellerPedidoId?: number; + }; + }[]; + assinatura?: { + assinaturaId?: number; + grupoAssinaturaId?: number; + tipoPeriodo?: string; + tempoPeriodo?: number; + percentualDesconto?: number; + }[]; + pagamento?: { + formaPagamentoId?: number; + numeroParcelas?: number; + valorParcela?: number; + valorDesconto?: number; + valorJuros?: number; + valorTotal?: number; + boleto?: { + urlBoleto?: string; + codigoDeBarras?: string; + }; + cartaoCredito?: { + numeroCartao?: string; + nomeTitular?: string; + dataValidade?: string; + codigoSeguranca?: string; + documentoCartaoCredito?: string; + token?: string; + info?: string; + bandeira?: string; + }[]; + pagamentoStatus?: { + numeroAutorizacao?: string; + numeroComprovanteVenda?: string; + dataAtualizacao?: string; + dataUltimoStatus?: string; + adquirente?: string; + tid?: string; + }[]; + informacoesAdicionais?: { + chave?: string; + valor?: string; + }[]; + }[]; + observacao?: { + observacao?: string; + usuario?: string; + data?: string; + publica?: boolean; + }[]; + valorCreditoFidelidade?: number; + valido?: boolean; + valorSubTotalSemDescontos?: number; + pedidoSplit?: number[]; + }[]; + }; + /** @description Lista de scripts */ + "GET /gestorscripts/scripts": { + response: { + scriptId?: number; + nome?: string; + posicao?: string; + tipoPagina?: string; + dataInicial?: string; + datafinal?: string; + ativo?: boolean; + prioridade?: number; + }[]; + }; + /** @description Portfolio encontrado */ + "GET /portfolios/:nome": { + response: { + portfolioId?: number; + nome?: string; + ativo?: boolean; + }; + }; + /** @description Lista de categorias de um produto */ + "GET /produtos/:identificador/categorias": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId" | "ProdutoId"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadRegistros?: number; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + caminhoHierarquia?: string; + categoriaPrincipal?: boolean; + }[]; + }; + /** @description Lista de Atacarejos */ + "GET /produtos/:identificador/atacarejo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }[]; + }; + /** @description Retorna usuário encontrado */ + "GET /usuarios/:usuarioId/enderecos": { + response: { + enderecoId?: number; + nomeEndereco?: string; + rua?: string; + numero?: string; + complemento?: string; + referencia?: string; + bairro?: string; + cidade?: string; + estado?: string; + cep?: string; + utilizadoUltimoPedido?: boolean; + pais?: string; + }[]; + }; + /** @description Lista com o retorno do processamento dos produtos enviados */ + "PUT /tabelaPrecos/:tabelaPrecoId/produtos": { + body: { + /** + * Lista de produtos variantes + */ + RAW_BODY: { + /** + * SKU do produto + */ + sku?: string; + /** + * Preço De do produto + */ + precoDe?: number; + /** + * Preço Por do produto + */ + precoPor?: number; + }[]; + }; + response: { + sucesso?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + erro?: { + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** @description Deleta um hotsite que foi inserido manualmente, hotsites gerados automaticamente não podem ser deletados */ + "DELETE /hotsites/:hotsiteId": {}; + /** @description Recorrências cadastradas na loja */ + "GET /assinaturas/recorrencias": { + response: { + recorrencias?: string[]; + }; + }; + /** @description Atualiza rastreamento completo (com os dados da N.F.) */ + "PUT /pedidos/:pedidoId/rastreamento/:pedidoRastreamentoId": { + body: { + /** + * Objeto Pedido Rastreamento + */ + RAW_BODY: { + /** + * Número da nota fiscal + */ + notaFiscal?: string; + /** + * Código Fiscal de Operações e Prestações + */ + cfop?: number; + /** + * Data Envio + */ + dataEnviado?: string; + /** + * Chave de Acesso NFE + */ + chaveAcessoNFE?: string; + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de rastreamento (optional) + */ + urlRastreamento?: string; + /** + * Transportadora (optional) + */ + transportadora?: string; + /** + * Data da entrega (optional) + */ + dataEntrega?: string; + }; + }; + }; + /** @description Adiciona o vínculo entre um produto e uma categoria com base na lista enviada */ + "POST /produtos/:identificador/categorias": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Id da Categoria Principal (optional) + */ + categoriaPrincipalId?: number; + /** + * Id da categoria a qual o produto deverá ser vinculado (optional) + */ + listaCategoriaId?: number[]; + }; + }; + /** @description Atualiza a prioridade de um centro de distribuição */ + "PUT /centrosdistribuicao/:centroDistribuicaoId/prioridade": { + body: { + /** + * (optional) + */ + incrementoOrdem?: number; + /** + * (optional) + */ + desativarPriorizacao?: boolean; + }; + response: {}; + }; + /** @description Insere um novo conteúdo na loja */ + "POST /conteudos": { + body: { + /** + * Titulo do conteúdo + */ + titulo?: string; + /** + * Conteúdo ativo/inativo + */ + ativo?: boolean; + /** + * Data de inicio de exibição do conteúdo (optional) + */ + dataInicio?: string; + /** + * Data final de exibição do conteúdo (optional) + */ + dataFim?: string; + /** + * Posicionamento do conteúdo + */ + posicionamento?: + | "Topo" + | "Centro" + | "Rodape" + | "LateralDireita" + | "LateralEsquerda" + | "MobileTopo" + | "MobileRodape"; + /** + * Informações do conteúdo + */ + conteudo?: string; + /** + * Insira em qual Termo de Busca o Conteúdo será exibido (optional) + */ + termoBusca?: string; + /** + * Exibição do conteúdo nas buscas + */ + exibeTodasBuscas?: boolean; + /** + * Não exibição do conteúdo nas buscas + */ + naoExibeBuscas?: boolean; + /** + * Exibição do conteúdo nos hotsites + */ + exibeTodosHotsites?: boolean; + /** + * Insira quais Hotsites que o Conteúdo será exibido (optional) + */ + hotsitesId?: number[]; + }; + }; + /** @description Atualiza a imagem de estampa do produto */ + "PUT /produtos/:identificador/imagens/estampa": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Id da imagem que será marcada como estampa + */ + idImagem?: number; + }; + }; + /** @description Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página) */ + "GET /usuarios/newsletter": { + searchParams: { + /** + * Tipo de ordenação + */ + ordenarPor?: "DataCadastro" | "DataAtualizacao"; + /** + * Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Status do usuário + */ + status?: boolean; + /** + * DoubleOptIn aceito (verificar estado da configuração) + */ + doubleOptIn?: boolean; + }; + response: { + nome?: string; + email?: string; + sexo?: string; + status?: boolean; + grupoInformacao?: { + nome?: string; + valor?: string; + }[]; + }[]; + }; + /** @description Ativa ou desativa um endereço de um usuário com base no e-mail do usuário */ + "PUT /usuarios/:email/enderecos/:enderecoId/ativar": { + body: { + /** + * Status do endereço + */ + status?: boolean; + }; + }; + /** @description Conteúdos encontrados */ + "GET /conteudos": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadePorPagina?: number; + }; + response: { + conteudoId?: number; + titulo?: string; + ativo?: boolean; + dataInicio?: string; + dataFim?: string; + posicionamento?: string; + codigoFonte?: string; + termoBusca?: string; + exibeTodasBuscas?: boolean; + naoExibeBuscas?: boolean; + exibeTodosHotsites?: boolean; + hotsitesId?: number[]; + }[]; + }; + /** @description Insere uma avaliação para um produto variante */ + "POST /produtoavaliacao/:identificador": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Texto referente a avaliação do produto + */ + comentario?: string; + /** + * Escala de 1 a 5 para avaliar o produto + */ + avaliacao?: number; + /** + * Identificado do usuário + */ + usuarioId?: number; + /** + * Referente a data que a avaliação foi criada + */ + dataAvaliacao?: string; + /** + * Nome do usuário que avaliou + */ + nome?: string; + /** + * Email do usuário que avaliou + */ + email?: string; + /** + * Referente ao status que libera a visualização da avaliação no site + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + }; + }; + /** @description Lista de hotsites */ + "GET /hotsites": { + searchParams: { + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadePorPagina?: number; + }; + response: { + hotsiteId?: number; + nome?: string; + ativo?: boolean; + template?: string; + dataCriacao?: string; + dataInicio?: string; + dataFinal?: string; + url?: string; + tamanhoPagina?: number; + templateId?: number; + ordenacao?: string; + listaProdutos?: { + expressao?: string; + produtos?: { + produtoId?: number; + ordem?: number; + }[]; + }; + seo?: { + seoHotsiteId?: number; + hotsiteId?: number; + titulo?: string; + metas?: { + conteudo?: string; + nome?: string; + httpEquiv?: string; + scheme?: string; + }[]; + }; + banners?: { + bannerId?: number; + }[]; + conteudos?: { + conteudoId?: number; + }[]; + }[]; + }; + /** @description Relatório de receitas de um determinado período */ + "GET /dashboard/receita": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** @description Vincula um ou mais conteúdos a um hotsite específico */ + "POST /hotsites/:hotsiteId/conteudos": { + body: { + /** + * Lista de identificadores de conteúdos a serem vinculados + */ + RAW_BODY: { + /** + * Identificador do conteúdo + */ + conteudoId?: number; + }[]; + }; + }; + /** @description Insere um novo contrato de frete */ + "POST /fretes": { + body: { + /** + * Nome do contrato de frete (optional) + */ + nome?: string; + /** + * Status do contrato de frete (optional) + */ + ativo?: boolean; + /** + * Volume máximo permitido , em metro cúbico (m³). (optional) + */ + volumeMaximo?: number; + /** + * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) + */ + pesoCubado?: number; + /** + * Id da configuração entrega agendada (optional) + */ + entregaAgendadaConfiguracaoId?: number; + /** + * URL rastreamento (optional) + */ + linkRastreamento?: string; + /** + * Contrato é exclusivo assinatura (optional) + */ + ehAssinatura?: boolean; + /** + * Informe a largura máxima, em centímetros (cm). (optional) + */ + larguraMaxima?: number; + /** + * Informe a altura máxima, em centímetros (cm). (optional) + */ + alturaMaxima?: number; + /** + * Informe o comprimento máximo, em centímetros (cm). (optional) + */ + comprimentoMaximo?: number; + /** + * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) + */ + limiteMaximoDimensoes?: number; + /** + * Informe o limite de peso cubado, em gramas (g). (optional) + */ + limitePesoCubado?: number; + /** + * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) + */ + tempoMinimoDespacho?: number; + /** + * Informe o Id do centro de distribuição (optional) + */ + centroDistribuicaoId?: number; + /** + * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) + */ + valorMinimoProdutos?: number; + }; + }; + /** @description Detalhes de uma assinatura */ + "GET /assinaturas/:assinaturaId": { + response: { + assinaturaId?: number; + usuarioId?: number; + dataProximoPedido?: string; + periodoRecorrencia?: string; + situacaoAssinatura?: string; + dataAssinatura?: string; + grupoAssinatura?: string; + enderecoId?: number; + usuarioCartaoCreditoId?: number; + cupom?: string; + produtos?: { + assinaturaProdutoId?: number; + assinaturaId?: number; + produtoId?: number; + produtoVarianteId?: number; + quantidade?: number; + valor?: number; + removido?: boolean; + }[]; + }; + }; + /** @description Buscar autor pelo nome */ + "GET /autores/:nomeAutor": {}; + /** @description Lista o conteúdo de uma versão */ + "GET /gestorscripts/scripts/:scriptId/versao/:versaoId/conteudo": { + response: { + scriptId?: number; + versaoId?: number; + conteudo?: string; + }[]; + }; + /** @description Remove o vinculo de produtos de um Grupo de Personalização */ + "DELETE /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { + body: { + /** + * Lista de Id dos produtos + */ + RAW_BODY: { + /** + * Id do produto + */ + produtoId?: number; + }[]; + }; + }; + /** @description Altera a data de recorrência de uma assinatura */ + "PUT /assinaturas/:assinaturaId/proximaRecorrencia": { + body: { + /** + * Data da próxima recorrência (Será considerado apenas o dia, mês e ano. Hora e minutos não serão considerados) + */ + proximaRecorrencia?: string; + }; + }; + /** @description Lista de parceiros com pedidos */ + "GET /parceiros/comPedidos": { + searchParams: { + /** + * Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss) + */ + dataInicial?: string; + /** + * Data final dos pedidos (aaaa-mm-dd hh:mm:ss) + */ + dataFinal?: string; + }; + response: { + parceiroId?: number; + marketPlaceId?: number; + nome?: string; + tabelaPrecoId?: number; + portfolioId?: number; + tipoEscopo?: string; + ativo?: boolean; + isMarketPlace?: boolean; + origem?: string; + }[]; + }; + /** @description Insere um ou mais metatags para um produto */ + "POST /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno da fstore + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { + /** + * Lista de metatags (optional) + */ + metas?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; + }[]; + }; + response: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; + }; + /** @description Frete atualizado com sucesso */ + "PUT /fretes/:freteId": { + body: { + /** + * Nome do contrato de frete (optional) + */ + nome?: string; + /** + * Status do contrato de frete (optional) + */ + ativo?: boolean; + /** + * Volume máximo permitido, em metro cúbico (m³). (optional) + */ + volumeMaximo?: number; + /** + * Informe o peso cubado. Altura x largura x profundidade x fator de cubagem. (optional) + */ + pesoCubado?: number; + /** + * Id da configuração entrega agendada (optional) + */ + entregaAgendadaConfiguracaoId?: number; + /** + * URL rastreamento (optional) + */ + linkRastreamento?: string; + /** + * Contrato é exclusivo assinatura (optional) + */ + ehAssinatura?: boolean; + /** + * Informe a largura máxima, em centímetros (cm). (optional) + */ + larguraMaxima?: number; + /** + * Informe a altura máxima, em centímetros (cm). (optional) + */ + alturaMaxima?: number; + /** + * Informe o comprimento máximo, em centímetros (cm). (optional) + */ + comprimentoMaximo?: number; + /** + * Informe a soma das três dimensões (Largura + Altura + Comprimento), em centímetros (cm). (optional) + */ + limiteMaximoDimensoes?: number; + /** + * Informe o limite de peso cubado, em gramas (g). (optional) + */ + limitePesoCubado?: number; + /** + * Informe quantos dias no mínimo esse contrato de frete leva para ser enviado ao cliente (optional) + */ + tempoMinimoDespacho?: number; + /** + * Informe o Id do centro de distribuição (optional) + */ + centroDistribuicaoId?: number; + /** + * Informe o valor mínimo em produtos necessário para disponibilidade da tabela de frete (optional) + */ + valorMinimoProdutos?: number; + }; + }; + /** @description Lista de detalhes de frete */ + "GET /fretes/:freteId/detalhes": { + response: { + freteId?: number; + cepInicial?: number; + cepFinal?: number; + variacoesFreteDetalhe?: { + pesoInicial?: number; + pesoFinal?: number; + valorFrete?: number; + prazoEntrega?: number; + valorPreco?: number; + valorPeso?: number; + }[]; + }[]; + }; + /** @description Buscar todos os autores */ + "GET /autores": {}; + /** @description Adiciona uma nova informação */ + "POST /produtos/:identificador/informacoes": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define o tipo de retorno a ser recebido. Id retorna o InformacaoProdutoId da informação inserida, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + */ + tipoRetorno?: "Id" | "Booleano"; + }; + body: { + /** + * Titulo da informação (optional) + */ + titulo?: string; + /** + * Texto da informação (optional) + */ + texto?: string; + /** + * Informação se o produto variante está visível no site. + */ + exibirSite?: boolean; + /** + * Tipo de informação do produto (optional) + */ + tipoInformacao?: + | "Informacoes" + | "Beneficios" + | "Especificacoes" + | "DadosTecnicos" + | "Composicao" + | "ModoDeUsar" + | "Cuidados" + | "ItensInclusos" + | "Dicas" + | "Video" + | "Descricao" + | "ValorReferente" + | "PopUpReferente" + | "Prescricao" + | "TabelaDeMedidas" + | "Spot" + | "Sinopse" + | "Carrinho"; + }; + }; + /** @description Usuário encontrado */ + "GET /usuarios/cnpj/:cnpj": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** @description Deleta um produto da lista de sugestões de produtos de um tipo de evento */ + "DELETE /tiposEvento/:tipoEventoId/produto/:produtoVarianteId": {}; + /** @description Deleta o vinculo de um produto a um evento */ + "DELETE /eventos/:eventoId/produto/:produtoVarianteId": { + response: string; + }; + /** @description Lista de Metatags do produto informado */ + "GET /produtos/:identificador/seo/metaTag": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + response: { + metatagId?: number; + content?: string; + httpEquiv?: string; + name?: string; + scheme?: string; + }[]; + }; + /** @description Define uma categoria de um produto como principal */ + "PUT /produtos/:identificador/categoriaPrincipal": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Id da categoria + */ + categoriaId?: number; + }; + }; + /** @description Atualiza o estoque de vários produtos com base na lista enviada. Limite de 50 produtos por requisição */ + "PUT /produtos/estoques": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Lista com os dados da atualização do estoque (optional) + */ + RAW_BODY: { + /** + * Valor único utilizado para identificar o produto + */ + identificador?: string; + /** + * Prazo de entrega do produto + */ + prazoEntrega?: number; + /** + * Lista com os dados da atualização do estoque + */ + listaEstoque?: { + /** + * Estoque físico do produto + */ + estoqueFisico?: number; + /** + * Estoque reservado do produto + */ + estoqueReservado?: number; + /** + * Id do centro de distribuição do estoque do produto + */ + centroDistribuicaoId?: number; + /** + * Id do produto variante + */ + produtoVarianteId?: number; + /** + * Quantidade para ativar o alerta de estoque + */ + alertaEstoque?: number; + }[]; + }[]; + }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + centroDistribuicaoId?: number; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + centroDistribuicaoId?: number; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** @description Objeto com o estoque total e o estoque por centro de distribuição de um produto variante */ + "GET /produtos/:identificador/estoque": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + estoqueFisico?: number; + estoqueReservado?: number; + listProdutoVarianteCentroDistribuicaoEstoque?: { + centroDistribuicaoId?: number; + nome?: string; + estoqueFisico?: number; + estoqueReservado?: number; + }[]; + }; + }; + /** @description Atualiza um script existente */ + "PUT /gestorscripts/scripts/:scriptId": { + body: { + /** + * Nome do script + */ + nome?: string; + /** + * Data inicial do script + */ + dataInicial?: string; + /** + * Data final do script + */ + dataFinal?: string; + /** + * Informe se o script está ativo ou não + */ + ativo?: boolean; + /** + * Prioridade do script + */ + prioridade?: number; + /** + * Posição do script + */ + posicao?: + | "HeaderPrimeiraLinha" + | "HeaderUltimaLinha" + | "BodyPrimeiraLinha" + | "BodyUltimaLinha" + | "FooterPrimeiraLinha" + | "FooterUltimeLinha"; + /** + * Tipo da página do script + */ + tipoPagina?: + | "Todas" + | "Home" + | "Busca" + | "Categoria" + | "Fabricante" + | "Estaticas" + | "Produto" + | "Carrinho"; + /** + * Identificador da página + */ + identificadorPagina?: string; + /** + * Conteúdo do script + */ + conteudo?: string; + /** + * Status do script + */ + publicado?: boolean; + }; + }; + /** @description Lista de fabricantes */ + "GET /fabricantes": { + response: { + fabricanteId?: number; + ativo?: boolean; + nome?: string; + urlLogoTipo?: string; + urlLink?: string; + urlCarrossel?: string; + }[]; + }; + /** @description Categoria encontrada */ + "GET /categorias/:id": { + searchParams: { + /** + * Hierarquia da categoria + */ + hierarquia?: boolean; + /** + * Se será apresentado somente categorias filhas + */ + somenteFilhos?: boolean; + }; + response: { + id?: number; + nome?: string; + categoriaPaiId?: number; + categoriaERPId?: string; + ativo?: boolean; + isReseller?: boolean; + exibirMatrizAtributos?: string; + quantidadeMaximaCompraUnidade?: number; + valorMinimoCompra?: number; + exibeMenu?: boolean; + urlHotSite?: string; + }; + }; + /** @description Vincula um ou mais banners a um hotsite específico */ + "POST /hotsites/:hotsiteId/banners": { + body: { + /** + * Lista de identificadores de banners para vincular ao hotsite + */ + banners?: { + /** + * Identificador do banner (optional) + */ + bannerId?: number; + }[]; + }; + }; + /** @description Exclui uma tabela de preços */ + "DELETE /tabelaPrecos/:tabelaPrecoId": {}; + /** @description Remove uma Loja Física */ + "DELETE /lojasFisicas/:lojaFisicaId": {}; + /** @description Parceiro atualizado com sucesso */ + "PUT /parceiros/:parceiroId": { + body: { + /** + * Nome do parceiro + */ + nome?: string; + /** + * Id da tabela de preço (optional) + */ + tabelaPrecoId?: number; + /** + * Id do portfolio (optional) + */ + portfolioId?: number; + /** + * Tipo de escopo + */ + tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; + /** + * Status do parceiro + */ + ativo?: boolean; + /** + * Se o parceiro é marketplace (optional) + */ + isMarketPlace?: boolean; + /** + * Origem (optional) + */ + origem?: string; + /** + * alias (optional) + */ + alias?: string; + }; + response: { + resultadoOperacao?: boolean; + codigo?: number; + mensagem?: string; + }[]; + }; + /** @description Usuário encontrado */ + "GET /usuarios/usuarioId/:usuarioId": { + response: { + usuarioId?: number; + bloqueado?: boolean; + grupoInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + tipoPessoa?: string; + origemContato?: string; + tipoSexo?: string; + nome?: string; + cpf?: string; + email?: string; + rg?: string; + telefoneResidencial?: string; + telefoneCelular?: string; + telefoneComercial?: string; + dataNascimento?: string; + razaoSocial?: string; + cnpj?: string; + inscricaoEstadual?: string; + responsavel?: string; + dataCriacao?: string; + dataAtualizacao?: string; + revendedor?: boolean; + listaInformacaoCadastral?: { + chave?: string; + valor?: string; + }[]; + avatar?: string; + ip?: string; + aprovado?: boolean; + }; + }; + /** @description Lista de fretes */ + "GET /fretes": { + response: { + freteId?: number; + nome?: string; + ativo?: boolean; + volumeMaximo?: number; + pesoCubado?: number; + entregaAgendadaConfiguracaoId?: number; + linkRastreamento?: string; + ehAssinatura?: boolean; + larguraMaxima?: number; + alturaMaxima?: number; + comprimentoMaximo?: number; + limiteMaximoDimensoes?: number; + limitePesoCubado?: number; + tempoMinimoDespacho?: number; + centroDistribuicaoId?: number; + valorMinimoProdutos?: number; + }[]; + }; + /** @description Vinculo de produtos ao portfolio */ + "PUT /portfolios/:portfolioId/produtos": { + body: { + /** + * Lista dos Id's dos produtos + */ + RAW_BODY: { + /** + * Id do produto + */ + produtoId?: number; + }[]; + }; + }; + /** @description Vincula produtos a um Grupo de Personalização */ + "POST /grupospersonalizacao/:grupoPersonalizacaoId/produtos": { + body: { + /** + * Lista de Id dos produtos + */ + RAW_BODY: { + /** + * Id do produto + */ + produtoId?: number; + }[]; + }; + }; + /** @description Atacarejo */ + "GET /produtos/:identificador/atacarejo/:produtoVarianteAtacadoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }; + }; + /** @description Produtos Mais Vendidos */ + "GET /dashboard/produtos": { + searchParams: { + /** + * Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Id do parceiro + */ + parceiroId?: number; + }; + response: { + produtoVarianteId?: number; + nomeProduto?: string; + sku?: string; + quantidade?: number; + receita?: string; + }[]; + }; + /** @description Atualiza rastreamento parcial (Rastreamento e UrlRastreamento) */ + "PUT /pedidos/:pedidoId/produtos/:produtoVarianteId/rastreamento/:pedidoRastreamentoProdutoId/parcial": + { + body: { + /** + * Objeto Pedido Rastreamento Produto + */ + RAW_BODY: { + /** + * Rastreamento (optional) + */ + rastreamento?: string; + /** + * URL de Rastreamento (optional) + */ + urlRastreamento?: string; + }; + }; + }; + /** @description Atualiza o status do banner pelo id */ + "PUT /banners/:bannerId/status": { + body: { + /** + * Status para qual deve ir o baner: Ativo (true) ou Inativo (false) + */ + status?: boolean; + }; + }; + /** @description Remove um valor pré definido */ + "DELETE /usuarios/valoresdefinidoscadastropersonalizado/:valoresDefinidosCampoGrupoInformacaoId": + {}; + /** @description Atualiza um endereço de um usuário pelo id do usuário */ + "PUT /usuarios/:usuarioId/enderecos/:enderecoId": { + body: { + /** + * Nome de identificação do endereço a ser cadastrado (Max Length: 100) + */ + nomeEndereco?: string; + /** + * Nome da rua (Max Length: 500) + */ + rua?: string; + /** + * Número do local (Max Length: 50) + */ + numero?: string; + /** + * Complemento (Max Length: 250) (optional) + */ + complemento?: string; + /** + * Referência para a localização do endereço (Max Length: 500) (optional) + */ + referencia?: string; + /** + * Bairro do endereço (Max Length: 100) + */ + bairro?: string; + /** + * Cidade em que se localiza o endereço (Max Length: 100) + */ + cidade?: string; + /** + * O estado (Max Length: 100) + */ + estado?: string; + /** + * Código do cep (Max Length: 50) + */ + cep?: string; + }; + }; + /** @description Vincula hotsites com um banner específico */ + "POST /banners/:bannerId/hotsites": { + body: { + /** + * lista de identificadores de hotsites a serem vinculados ao banner + */ + RAW_BODY?: { + /** + * Id do hotsite (optional) + */ + hotSiteId?: number; + }[]; + }; + }; + /** @description Insere um range de cep em uma Loja Física */ + "POST /lojasFisicas/:lojaFisicaId/rangeCep": { + body: { + /** + * Nome do range de cep + */ + nome?: string; + /** + * Cep inicial do range. Formato: 00.000-000 + */ + cepInicial?: string; + /** + * Cep final do range. Formato: 00.000-000 + */ + cepFinal?: string; + }; + }; + /** @description Lista de avaliações de produtos */ + "GET /produtos/:identificador/avaliacoes": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado'] + */ + status?: "Pendente" | "NaoAprovado" | "Aprovado"; + /** + * Página da lista (padrão: 1) + */ + pagina?: number; + /** + * Quantidade de registros que deverão retornar (max: 50) + */ + quantidadeRegistros?: number; + }; + response: { + produtoVarianteId?: number; + sku?: string; + produtoAvaliacaoId?: number; + comentario?: string; + avaliacao?: number; + usuarioId?: number; + dataAvaliacao?: string; + nome?: string; + email?: string; + status?: string; + }[]; + }; + /** @description Atualiza um usuário pelo id */ + "PUT /usuarios/:usuarioId": { + body: { + /** + * Tipo de pessoa + */ + tipoPessoa?: "Fisica" | "Juridica"; + /** + * Origem do contato + */ + origemContato?: + | "Google" + | "Bing" + | "Jornal" + | "PatrocinioEsportivo" + | "RecomendacaoAlguem" + | "Revista" + | "SiteInternet" + | "Televisao" + | "Outro" + | "UsuarioImportadoViaAdmin" + | "PayPalExpress"; + /** + * Tipo Sexo (optional) + */ + tipoSexo?: "Undefined" | "Masculino" | "Feminino"; + /** + * Nome do usuário (Max Length: 100) + */ + nome?: string; + /** + * CPF do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + cpf?: string; + /** + * E-mail do usuário (Max Length: 100) + */ + email?: string; + /** + * RG do usuário caso seja pessoa física (Max Length: 50) (optional) + */ + rg?: string; + /** + * Telefone residencial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) + */ + telefoneResidencial?: string; + /** + * Telefone celular do usuário. Deve ser informado o DDD junto ao número (Max Length: 50) (optional) + */ + telefoneCelular?: string; + /** + * Telefone comercial do usuário. Deve ser informado o DDD junto ao número(Max Length: 50) (optional) + */ + telefoneComercial?: string; + /** + * Data de nascimento (optional) + */ + dataNascimento?: string; + /** + * Razão social do usuário, caso seja uma pessoa jurídica(Max Length: 100) (optional) + */ + razaoSocial?: string; + /** + * CNPJ do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + cnpj?: string; + /** + * Inscrição estadual do usuário, caso seja uma pessoa jurídica(Max Length: 50) (optional) + */ + inscricaoEstadual?: string; + /** + * Responsável(Max Length: 100) (optional) + */ + responsavel?: string; + /** + * Data de criação do cadastro (optional) + */ + dataCriacao?: string; + /** + * Data de atualização do cadastro (optional) + */ + dataAtualizacao?: string; + /** + * Se o usuário é revendedor (optional) + */ + revendedor?: boolean; + /** + * Informação cadastral (optional) + */ + listaInformacaoCadastral?: { + /** + * Chave + */ + chave?: string; + /** + * Valor + */ + valor?: string; + }[]; + /** + * Avatar (Max Length: 50) (optional) + */ + avatar?: string; + /** + * IP do usuário (Max Length: 20) (optional) + */ + ip?: string; + /** + * Seta ou retorna o valor de Aprovado (optional) + */ + aprovado?: boolean; + }; + }; + /** @description Lista de observações de um pedido */ + "GET /pedidos/:pedidoId/observacao": { + response: { + observacao?: string; + usuario?: string; + publica?: boolean; + data?: string; + }[]; + }; + /** @description Tabela de preços específica */ + "GET /tabelaPrecos/:tabelaPrecoId": { + response: { + tabelaPrecoId?: number; + nome?: string; + dataInicial?: string; + dataFinal?: string; + ativo?: boolean; + isSite?: boolean; + }; + }; + /** @description Liberar reservas de pedidos */ + "POST /pedidos/liberarReservas": { + body: { + /** + * Números dos pedidos que se deseja buscar + */ + RAW_BODY: number[]; + }; + }; + /** @description Atualiza para o mesmo preço, todos os variantes de um produto encontrado com o SKU informado. Limite de 50 produtos por requisição */ + "PUT /produtos/precos/lote": { + body: { + /** + * Lista com os dados da atualização do preço por lote + */ + RAW_BODY: { + /** + * Identificador do produto (SKU) + */ + sku?: string; + /** + * Preço de custo do produto variante. Se passado 0 irá setar os valores para zero, se for NULO, não irá atualizar o preço de custo (optional) + */ + precoCusto?: number; + /** + * "PrecoDe" do produto variante + */ + precoDe?: number; + /** + * "PrecoPor" do produto variante + */ + precoPor?: number; + /** + * Fator multiplicador que gera o preço de exibição do produto. Ex.: produtos que exibem o preço em m² e cadastram o preço da caixa no "PrecoPor". (1 por padrão) (optional) + */ + fatorMultiplicadorPreco?: number; + }[]; + }; + response: { + produtosNaoAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + produtosAtualizados?: { + produtoVarianteId?: number; + sku?: string; + resultado?: boolean; + detalhes?: string; + }[]; + }; + }; + /** @description Deleta o vinculo de um ou mais hotsites com um banner específico */ + "DELETE /banners/:bannerId/hotsites": { + body: { + /** + * Lista de identificadores de hotsites para desvincular do banner (optional) + */ + listaHotsites?: { + /** + * Id do hotsite para vinculo com banner + */ + hotSiteId?: { + /** + * Id do hotsite para vinculo com banner + */ + hotSiteId?: unknown[]; + }[]; + }; + }; + }; + /** @description Atualiza a exibição do banner em parceiros, se deve ser em todos ou não */ + "PUT /banners/:bannerId/Parceiros": { + body: { + /** + * Exibição do banner em parceiros + */ + exibirEmTodosParceiros?: boolean; + }; + }; + /** @description Atualiza um SEO de um produto específico */ + "PUT /produtos/:identificador/seo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno + */ + tipoIdentificador?: "Sku" | "ProdutoId" | "ProdutoVarianteId"; + }; + body: { + /** + * Informe a URL a ser inserida na TAG Canonical. Caso nenhum dado seja inserido, a TAG Canonical não será inserida na Página do Produto (optional) + */ + tagCanonical?: string; + /** + * Informe o title da página do produto (optional) + */ + title?: string; + /** + * Informe os dados da Meta Tag (optional) + */ + metaTags?: { + /** + * Dados da Meta Tag + */ + content?: string; + /** + * Dados da Meta Tag + */ + httpEquiv?: string; + /** + * Dados da Meta Tag + */ + name?: string; + /** + * Dados da Meta Tag + */ + scheme?: string; + }[]; + }; + }; + /** @description Retorna lista contendo os Id's dos pedidos do usuário */ + "GET /usuarios/documento/:documento/pedidos": { + searchParams: { + /** + * Define se o documento informado é um CPF ou um CNPJ + */ + tipoDocumento?: "Cpf" | "Cnpj"; + }; + response: { + pedidoId?: number; + links?: { + href?: string; + rel?: string; + method?: string; + }[]; + }[]; + }; + /** @description Objeto com o precoDe e precoPor de um produto variante */ + "GET /produtos/:identificador/preco": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + response: { + precoDe?: number; + precoPor?: number; + fatorMultiplicadorPreco?: number; + }; + }; + /** @description Adiciona novos Atacarejos */ + "POST /produtos/:identificador/atacarejo": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Lista de Atacarejos (optional) + */ + RAW_BODY: { + /** + * Preço atacado + */ + precoAtacado?: number; + /** + * Quantidade do produto + */ + quantidade?: number; + }[]; + }; + response: { + produtoVarianteAtacadoId?: number; + precoAtacado?: number; + quantidade?: number; + }[]; + }; + /** @description Objeto do hotsite */ + "GET /hotsites/:hotsiteId": { + response: { + hotsiteId?: number; + nome?: string; + ativo?: boolean; + template?: string; + dataCriacao?: string; + dataInicio?: string; + dataFinal?: string; + url?: string; + tamanhoPagina?: number; + templateId?: number; + ordenacao?: string; + listaProdutos?: { + expressao?: string; + produtos?: { + produtoId?: number; + ordem?: number; + }[]; + }; + seo?: { + seoHotsiteId?: number; + hotsiteId?: number; + titulo?: string; + metas?: { + conteudo?: string; + nome?: string; + httpEquiv?: string; + scheme?: string; + }[]; + }; + banners?: { + bannerId?: number; + }[]; + conteudos?: { + conteudoId?: number; + }[]; + }; + }; + /** @description Adiciona uma nova imagem vinculada a um produto */ + "POST /produtos/:identificador/imagens": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + /** + * Define o tipo de retorno a ser recebido. ListaIds retorna lista de Ids das imagens inseridas, Booleano retorna true ou false, de acordo com o resultado da operação. Valor padrão Booleano + */ + tipoRetorno?: "ListaIds" | "Booleano"; + }; + body: { + /** + * Lista com as imagens do produto no formato base 64 (optional) + */ + RAW_BODY: { + /** + * Imagem do produto em base64 + */ + base64?: string; + /** + * JPG ou PNG + */ + formato?: string; + /** + * Se a imagem será apresentada como miniatura + */ + exibirMiniatura?: boolean; + /** + * Se a imagem será apresentada como estampa + */ + estampa?: boolean; + /** + * Ordem para apresentação da imagem + */ + ordem?: number; + }[]; + }; + }; + /** @description Remove o vínculo entre usuário e parceiro */ + "DELETE /usuarios/:email/parceiro": { + body: { + /** + * Número identificador do parceiro (Max Length: 4) + */ + parceiroId?: number; + }; + }; + /** @description Insere um novo parceiro */ + "POST /parceiros": { + body: { + /** + * Nome do parceiro + */ + nome?: string; + /** + * Id da tabela de preço (optional) + */ + tabelaPrecoId?: number; + /** + * Id do portfolio (optional) + */ + portfolioId?: number; + /** + * Tipo de escopo + */ + tipoEscopo?: 'Aberto"' | "Fechado" | "PorCliente"; + /** + * Status do parceiro + */ + ativo?: boolean; + /** + * Se o parceiro é marketplace (optional) + */ + isMarketPlace?: boolean; + /** + * Origem (optional) + */ + origem?: string; + }; + }; + /** @description Lista de parceiros vinculados ao banner */ + "GET /banners/:bannerId/parceiros": {}; + /** @description Campo atualizado com sucesso */ + "PUT /usuarios/bloquear": { + body: { + /** + * Usuários (optional) + */ + RAW_BODY?: { + /** + * E-mail do usuário + */ + email?: string; + /** + * Status do usuário + */ + bloqueado?: boolean; + }[]; + }; + response: { + usuariosAtualizados?: string[]; + usuariosNaoAtualizados?: string[]; + }; + }; + /** @description Frete atualizado com sucesso */ + "PUT /fretes/:freteId/Ativo": { + body: { + /** + * Status para atualização do contrato de frete + */ + ativo?: boolean; + }; + }; + /** @description Atualiza a situação de uma assinatura específica */ + "PUT /assinaturas/:assinaturaId": { + body: { + /** + * Id do endereço (optional) + */ + enderecoId?: number; + /** + * Id do cartão de crédito do usuário (optional) + */ + usuarioCartaoCreditoId?: number; + /** + * Período Recorrência (optional) + */ + periodoRecorrencia?: string; + /** + * Situação da Assinatura (optional) + */ + situacaoAssinatura?: "Ativa" | "Pausada" | "Cancelada"; + /** + * Cupom (optional) + */ + cupom?: string; + }; + }; + /** @description Atualiza uma informação de um produto específico */ + "PUT /produtos/:identificador/informacoes/:informacaoId": { + searchParams: { + /** + * Define se o identificador informado é um sku ou um id interno. + */ + tipoIdentificador?: "Sku" | "ProdutoVarianteId"; + }; + body: { + /** + * Titulo da informação (optional) + */ + titulo?: string; + /** + * Texto da informação (optional) + */ + texto?: string; + /** + * Informação se o produto variante está visível no site. + */ + exibirSite?: boolean; + /** + * Tipo de informação do produto (optional) + */ + tipoInformacao?: + | "Informacoes" + | "Beneficios" + | "Especificacoes" + | "DadosTecnicos" + | "Composicao" + | "ModoDeUsar" + | "Cuidados" + | "ItensInclusos" + | "Dicas" + | "Video" + | "Descricao" + | "ValorReferente" + | "PopUpReferente" + | "Prescricao" + | "TabelaDeMedidas" + | "Spot" + | "Sinopse" + | "Carrinho"; + }; + }; + /** @description Insere uma nova tabela de preços */ + "POST /tabelaPrecos": { + body: { + /** + * Nome da tabela de preço + */ + nome?: string; + /** + * Data que inicia a tabela de preço + */ + dataInicial?: string; + /** + * Data de término da tabela de preço + */ + dataFinal?: string; + /** + * Status da tabela de preço + */ + ativo?: boolean; + }; + }; + /** @description Tipo evento buscado */ + "GET /tiposEvento/:tipoEventoId": { + response: { + tipoEventoId?: number; + nome?: string; + tipoEntrega?: string; + tipoDisponibilizacao?: string; + permitirRemocaoAutomaticaProdutos?: boolean; + corHexTituloInformacoes?: string; + corHexCorpoInformacoes?: string; + numeroAbasInformacoes?: number; + quantidadeDiasParaEventoExpirar?: number; + numeroLocaisEvento?: number; + ativo?: boolean; + disponivel?: boolean; + tipoBeneficiarioFrete?: string; + caminhoLogoEvento?: string; + caminhoSubTemplate?: string; + sugestaoProdutos?: { + tipoEventoId?: number; + produtoVarianteId?: number; + }[]; + }; + }; + /** @description Atualiza um novo Seller no marketplace */ + "PUT /resellers": { + searchParams: { + /** + * Valor único utilizado para identificar o seller + */ + resellerId?: number; + }; + body: { + /** + * Razão Social/Nome do Reseller + */ + razaoSocial?: string; + /** + * CNPJ do Seller + */ + cnpj?: string; + /** + * Inscrição Estadual do Seller + */ + inscricaoEstadual?: string; + /** + * Seller isento de inscrição estadual + */ + isento?: boolean; + /** + * Email de contato do Seller + */ + email?: string; + /** + * Telefone de contato do seller com ddd (xx) xxxx-xxxx + */ + telefone?: string; + /** + * Tipo de autonomia do vendedor + */ + tipoAutonomia?: "ComAutonomia" | "SemAutonomia"; + /** + * Seller Ativo + */ + ativo?: boolean; + /** + * Se irá ter Split de frete boolean. Default:false + */ + split?: boolean; + /** + * Se o produto deverá ser apresentado em BuyBox (apenas para Seller's e Marketplace's TrayCorp) boolean. Default:false, + */ + buyBox?: boolean; + /** + * Se os produtos deverão sem ativados automaticamente no marketplace boolean. Default:false, + */ + ativacaoAutomaticaProdutos?: boolean; + /** + * Cep do Seller (utilizado para o calculo de frete) + */ + cep?: string; + }; + }; + /** @description Gera um novo pedido para a assinatura */ + "POST /assinaturas/:assinaturaId/pedido": {}; + /** @description Xml com os dados das mídias entre duas datas */ + "GET /midias": { + searchParams: { + /** + * Data inicial (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final (aaaa-mm-dd) + */ + dataFinal?: string; + }; + }; + /** @description Relatório de ticket médio de um determinado período */ + "GET /dashboard/ticketMedio": { + searchParams: { + /** + * Data inicial dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataInicial?: string; + /** + * Data final dos pedidos que deverão retornar (aaaa-mm-dd) + */ + dataFinal?: string; + /** + * Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano) + */ + tipoAgrupamento?: "Hora" | "Dia" | "Semana" | "Mes" | "Ano"; + }; + response: { + tipoAgrupamento?: string; + dados?: { + data?: string; + pedidosCaptados?: number; + pedidosPagos?: number; + pedidosEnviados?: number; + pedidosCancelados?: number; + }[]; + }; + }; + /** @description Objeto com as cotações de frete */ + "GET /fretes/pedidos/:pedidoId/cotacoes": { + searchParams: { + /** + * Força cotação de todos os CD's. + */ + forcarCotacaoTodosCDs?: boolean; + }; + response: { + id?: string; + nome?: string; + prazo?: number; + tabelaFreteId?: string; + tipo?: string; + valor?: number; + centroDistribuicao?: number; + produtos?: { + produtoVarianteId?: number; + valor?: number; + centroDistribuicaoId?: number; + }[]; + }[]; + }; + /** @description Deleta o vinculo de um ou mais parceiros com um banner específico */ + "DELETE /banners/:bannerId/parceiros": { + body: { + /** + * Lista de identificadores de parceiros para desvincular do banner + */ + listaParceiros?: { + /** + * Id do parceiro (optional) + */ + parceiroId?: number; + }[]; + }; + }; +} diff --git a/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json b/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json new file mode 100644 index 000000000..293b5abe4 --- /dev/null +++ b/wake/utils/openapi/realiza-a-autenticacao-de-usuario-no-idm-identity-manager.openapi.json @@ -0,0 +1,122 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autenticacao/login": { + "post": { + "summary": "Realiza a autenticação de usuário no IDM (Identity Manager)", + "description": "Autenticação realizada com sucesso", + "operationId": "realiza-a-autenticacao-de-usuario-no-idm-identity-manager", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "login": { + "type": "string", + "description": "Login do usuário (optional)" + }, + "senha": { + "type": "string", + "description": "Senha do usuário (optional)" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "401": { + "description": "401", + "content": { + "application/json": { + "examples": { + "Usuário não autorizado": { + "value": "" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a224cf02d3d104ac570a4f" +} \ No newline at end of file diff --git a/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json b/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json new file mode 100644 index 000000000..4fd654d1a --- /dev/null +++ b/wake/utils/openapi/realiza-um-novo-lancamento-na-conta-corrente-do-cliente.openapi.json @@ -0,0 +1,165 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/contascorrentes/{email}": { + "post": { + "summary": "Realiza um novo lançamento na conta corrente do cliente", + "description": "", + "operationId": "realiza-um-novo-lancamento-na-conta-corrente-do-cliente", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valor": { + "type": "number", + "description": "Valor da conta corrente (optional)", + "format": "double" + }, + "tipoLancamento": { + "type": "string", + "description": "Tipo de Lançamento (optional)", + "enum": [ + "Credito", + "Debito" + ] + }, + "observacao": { + "type": "string", + "description": "Observação (optional)" + }, + "visivelParaCliente": { + "type": "boolean", + "description": "Se será visível para o cliente (optional)" + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Id da conta corrente gerada": { + "value": "\tId da conta corrente gerada" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa28db2ce54d00f9ba1799" +} \ No newline at end of file diff --git a/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json b/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json new file mode 100644 index 000000000..79f36ef94 --- /dev/null +++ b/wake/utils/openapi/realiza-uma-cotacao-de-frete.openapi.json @@ -0,0 +1,238 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/cotacoes": { + "post": { + "summary": "Realiza uma cotação de frete", + "description": "Método que realiza uma cotação de frete", + "operationId": "realiza-uma-cotacao-de-frete", + "parameters": [ + { + "name": "cep", + "in": "query", + "description": "Cep de entrega", + "schema": { + "type": "string" + } + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno da fstore", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "retiradaLoja", + "in": "query", + "description": "Define se deve retornar as opções de retirada em loja (\"False\" por padrão) (optional)", + "schema": { + "type": "boolean" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "valorTotal": { + "type": "number", + "description": "Valor total do pedido (optional)", + "format": "double" + }, + "produtos": { + "type": "array", + "description": "Lista de produtos da cotação", + "items": { + "properties": { + "identificador": { + "type": "string", + "description": "Id do produto variante" + }, + "quantidade": { + "type": "integer", + "description": "Quantidade do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaFreteId": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d58a11a77e00940d9613" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json new file mode 100644 index 000000000..c069c2052 --- /dev/null +++ b/wake/utils/openapi/remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { + "delete": { + "summary": "Remove o vinculo de produtos de um Grupo de Personalização", + "description": "", + "operationId": "remove-o-vinculo-de-produtos-de-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5bc15d737210013d9c741" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json new file mode 100644 index 000000000..428cd25c1 --- /dev/null +++ b/wake/utils/openapi/remove-o-vinculo-entre-usuario-e-parceiro.openapi.json @@ -0,0 +1,118 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/parceiro": { + "delete": { + "summary": "Remove o vínculo entre usuário e parceiro", + "description": "", + "operationId": "remove-o-vinculo-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "description": "Número identificador do parceiro (Max Length: 4)", + "format": "int32" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de90af7f1a57005c9d9eb3" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-atacarejo.openapi.json b/wake/utils/openapi/remove-um-atacarejo.openapi.json new file mode 100644 index 000000000..e267df3ec --- /dev/null +++ b/wake/utils/openapi/remove-um-atacarejo.openapi.json @@ -0,0 +1,155 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { + "delete": { + "summary": "Remove um Atacarejo", + "description": "", + "operationId": "remove-um-atacarejo", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c494d0b10de9008e230508" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json b/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json new file mode 100644 index 000000000..2aae960fe --- /dev/null +++ b/wake/utils/openapi/remove-um-campo-de-cadastro-personalizado.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/camposcadastropersonalizado/{camposcadastropersonalizadoId}": { + "delete": { + "summary": "Remove um campo de cadastro personalizado", + "description": "", + "operationId": "remove-um-campo-de-cadastro-personalizado", + "parameters": [ + { + "name": "camposcadastropersonalizadoId", + "in": "path", + "description": "Id do campo de cadastro personalizado", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec8a330c41d03ec86195a" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json b/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json new file mode 100644 index 000000000..2d50ad2fe --- /dev/null +++ b/wake/utils/openapi/remove-um-produto-de-uma-tabela-de-preco.openapi.json @@ -0,0 +1,112 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}/{sku}": { + "delete": { + "summary": "Remove um produto de uma tabela de preço", + "description": "", + "operationId": "remove-um-produto-de-uma-tabela-de-preco", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "sku", + "in": "path", + "description": "SKU do produto", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6aba558d7ad0277606612" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json b/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json new file mode 100644 index 000000000..06991844a --- /dev/null +++ b/wake/utils/openapi/remove-um-valor-pre-definido.openapi.json @@ -0,0 +1,103 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/valoresdefinidoscadastropersonalizado/{valoresDefinidosCampoGrupoInformacaoId}": { + "delete": { + "summary": "Remove um valor pré definido", + "description": "", + "operationId": "remove-um-valor-pre-definido", + "parameters": [ + { + "name": "valoresDefinidosCampoGrupoInformacaoId", + "in": "path", + "description": "Id dos valores definidos no campo grupo informação", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec9cb22add500fbf7fa8c" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json b/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json new file mode 100644 index 000000000..bc45ef886 --- /dev/null +++ b/wake/utils/openapi/remove-uma-lista-de-range-de-cep-de-uma-loja-fisica.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}/rangeCep": { + "delete": { + "summary": "Remove uma lista de range de cep de uma Loja Física", + "description": "", + "operationId": "remove-uma-lista-de-range-de-cep-de-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de range de cep a serem excluídos da loja física", + "items": { + "properties": { + "rangeCepId": { + "type": "integer", + "description": "Id da faixa de cep a ser deletado", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b9b784d123d90044a22b2c" +} \ No newline at end of file diff --git a/wake/utils/openapi/remove-uma-loja-fisica.openapi.json b/wake/utils/openapi/remove-uma-loja-fisica.openapi.json new file mode 100644 index 000000000..c0bf23255 --- /dev/null +++ b/wake/utils/openapi/remove-uma-loja-fisica.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}": { + "delete": { + "summary": "Remove uma Loja Física", + "description": "", + "operationId": "remove-uma-loja-fisica", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b99952fca2be0056fd9b64" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json b/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json new file mode 100644 index 000000000..afa346e49 --- /dev/null +++ b/wake/utils/openapi/retorna-a-lista-de-produtos-de-um-portfolio.openapi.json @@ -0,0 +1,116 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}/produtos": { + "get": { + "summary": "Retorna a lista de produtos de um portfolio", + "description": "Retorna a lista de produtos de um portfolio", + "operationId": "retorna-a-lista-de-produtos-de-um-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja buscar os produtos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef325f0a9ef006b096d11" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json b/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json new file mode 100644 index 000000000..899c50215 --- /dev/null +++ b/wake/utils/openapi/retorna-a-situacao-reseller-de-um-produto.openapi.json @@ -0,0 +1,126 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/situacaoReseller": { + "get": { + "summary": "Retorna a situação reseller de um produto", + "description": "", + "operationId": "retorna-a-situacao-reseller-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c43f8a273b800036c3a336" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json new file mode 100644 index 000000000..a3fe648c1 --- /dev/null +++ b/wake/utils/openapi/retorna-a-url-do-avatar-de-um-usuario.openapi.json @@ -0,0 +1,111 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/avatar": { + "get": { + "summary": "Retorna a url do avatar de um usuário", + "description": "Avatar do usuário encontrado", + "operationId": "retorna-a-url-do-avatar-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"urlAvatar\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "urlAvatar": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec2a6a17bb80165cf956e" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json b/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json new file mode 100644 index 000000000..78a38bee2 --- /dev/null +++ b/wake/utils/openapi/retorna-as-assinaturas-com-erros.openapi.json @@ -0,0 +1,150 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/erros": { + "get": { + "summary": "Retorna as assinaturas com erros", + "description": "Assinaturas com erro na loja", + "operationId": "retorna-as-assinaturas-com-erros", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final para buscas por periodo de tempo (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "resolvidos", + "in": "query", + "description": "Erros já resolvidos ou não", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.560Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0b2e0d9f32a0562852efd" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json b/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json new file mode 100644 index 000000000..a616fd918 --- /dev/null +++ b/wake/utils/openapi/retorna-as-assinaturas-de-um-determinado-usuario.openapi.json @@ -0,0 +1,228 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{email}": { + "get": { + "summary": "Retorna as assinaturas de um determinado usuário", + "description": "Produtos de uma assinatura", + "operationId": "retorna-as-assinaturas-de-um-determinado-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "e-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.170Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.170Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.170Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.170Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a720b61558d3003f1f3f21" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json b/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json new file mode 100644 index 000000000..cf1927fd9 --- /dev/null +++ b/wake/utils/openapi/retorna-as-recorrencias-cadastradas-na-loja.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/recorrencias": { + "get": { + "summary": "Retorna as recorrências cadastradas na loja", + "description": "Recorrências cadastradas na loja", + "operationId": "retorna-as-recorrencias-cadastradas-na-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"recorrencias\": [\n \"string\"\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "recorrencias": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a72307d7a8100053919a2a" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-da-loja.openapi.json b/wake/utils/openapi/retorna-dados-da-loja.openapi.json new file mode 100644 index 000000000..a96d01eb6 --- /dev/null +++ b/wake/utils/openapi/retorna-dados-da-loja.openapi.json @@ -0,0 +1,139 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/loja": { + "get": { + "summary": "Retorna dados da loja", + "description": "Dados da loja", + "operationId": "retorna-dados-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"nome\": \"string\",\n \"urlSite\": \"string\",\n \"urlCarrinho\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "urlSite": { + "type": "string", + "example": "string" + }, + "urlCarrinho": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "400": { + "description": "400", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5ee235e44b60096d8d631" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json b/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json new file mode 100644 index 000000000..1771d8cb6 --- /dev/null +++ b/wake/utils/openapi/retorna-dados-para-alimentar-o-grafico-forma-de-pagamento.openapi.json @@ -0,0 +1,172 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/graficoformapagamento": { + "get": { + "summary": "Retorna dados para alimentar o gráfico forma de pagamento", + "description": "Gráfico Forma de Pagamento", + "operationId": "retorna-dados-para-alimentar-o-grafico-forma-de-pagamento", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos com as formas de pagamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"cor\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4150a7e261001ab102fc" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json b/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json new file mode 100644 index 000000000..e8771f382 --- /dev/null +++ b/wake/utils/openapi/retorna-dados-para-carregar-o-grafico-do-faturamento.openapi.json @@ -0,0 +1,196 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/graficofaturamento": { + "get": { + "summary": "Retorna dados para carregar o gráfico do faturamento", + "description": "Gráfico do Faturamento", + "operationId": "retorna-dados-para-carregar-o-grafico-do-faturamento", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial do faturamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final do faturamento que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "isLoja", + "in": "query", + "description": "Se o faturamento é somente da loja", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"parceiro\": \"string\",\n \"receitaPagos\": 0,\n \"transacoesPagos\": 0,\n \"valorMedioPagos\": 0,\n \"usuarioEnderecoEstado\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "parceiro": { + "type": "string", + "example": "string" + }, + "receitaPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "transacoesPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMedioPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioEnderecoEstado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa369bf08a61002e60f7c3" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json b/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json new file mode 100644 index 000000000..88e00f0a1 --- /dev/null +++ b/wake/utils/openapi/retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja.openapi.json @@ -0,0 +1,231 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/faturamento": { + "get": { + "summary": "Retorna indicadores de faturamento (receita, ticket médio e número de pedidos) da loja", + "description": "Indicadores de Faturamento", + "operationId": "retorna-indicadores-de-faturamento-receita-ticket-medio-e-numero-de-pedidos-da-loja", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataInicialComparativo", + "in": "query", + "description": "Data inicial do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalComparativo", + "in": "query", + "description": "Data final do comparativo dos indicadores que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"indicadorReceita\": 0,\n \"indicadorPedido\": 0,\n \"indicadorTicketMedio\": 0,\n \"indicadorReceitaComparativo\": 0,\n \"indicadorPedidoComparativo\": 0,\n \"indicadorTicketMedioComparativo\": 0,\n \"indicadorReceitaFormatado\": \"string\",\n \"indicadorPedidoFormatado\": \"string\",\n \"indicadorTicketMedioFormatado\": \"string\",\n \"indicadorReceitaComparativoFormatado\": \"string\",\n \"indicadorPedidoComparativoFormatado\": \"string\",\n \"indicadorTicketMedioComparativoFormatado\": \"string\",\n \"indicadorReceitaPorcentagem\": \"string\",\n \"indicadorPedidoPorcentagem\": \"string\",\n \"indicadorTicketMedioPorcentagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "indicadorReceita": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorTicketMedio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorReceitaComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorPedidoComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorTicketMedioComparativo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "indicadorReceitaFormatado": { + "type": "string", + "example": "string" + }, + "indicadorPedidoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioFormatado": { + "type": "string", + "example": "string" + }, + "indicadorReceitaComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorPedidoComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioComparativoFormatado": { + "type": "string", + "example": "string" + }, + "indicadorReceitaPorcentagem": { + "type": "string", + "example": "string" + }, + "indicadorPedidoPorcentagem": { + "type": "string", + "example": "string" + }, + "indicadorTicketMedioPorcentagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa3538d6fe640062ab9c55" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json b/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json new file mode 100644 index 000000000..bbfc9885e --- /dev/null +++ b/wake/utils/openapi/retorna-lista-de-atacarejos-do-produto-variante.openapi.json @@ -0,0 +1,168 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/atacarejo": { + "get": { + "summary": "Retorna Lista de Atacarejos do Produto Variante", + "description": "Lista de Atacarejos", + "operationId": "retorna-lista-de-atacarejos-do-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4926cdd3939006bc5477a" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-eventos.openapi.json b/wake/utils/openapi/retorna-lista-de-eventos.openapi.json new file mode 100644 index 000000000..2b1dd9b23 --- /dev/null +++ b/wake/utils/openapi/retorna-lista-de-eventos.openapi.json @@ -0,0 +1,363 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos": { + "get": { + "summary": "Retorna lista de eventos", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "retorna-lista-de-eventos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data de inicio do evento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data do termino do evento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "disponivel", + "in": "query", + "description": "Status do evento", + "schema": { + "type": "boolean" + } + }, + { + "name": "titulo", + "in": "query", + "description": "Titulo do evento", + "schema": { + "type": "string" + } + }, + { + "name": "usuarioEmail", + "in": "query", + "description": "Email do Usuário", + "schema": { + "type": "string" + } + }, + { + "name": "tipoEventoId", + "in": "query", + "description": "Identificador do Tipo de Evento", + "schema": { + "type": "integer", + "format": "int64" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.747Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.747Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "userId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enderecoEntregaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.747Z" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:38.747Z" + }, + "titulo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "diasDepoisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "diasAntesEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlLogoEvento": { + "type": "string", + "example": "string" + }, + "urlCapaEvento": { + "type": "string", + "example": "string" + }, + "proprietarioEvento": { + "type": "string", + "example": "string" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo01": { + "type": "string", + "example": "string" + }, + "conteudoInfo01": { + "type": "string", + "example": "string" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo02": { + "type": "string", + "example": "string" + }, + "conteudoInfo02": { + "type": "string", + "example": "string" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "fotos": { + "type": "string", + "example": "string" + }, + "enumTipoListaPresenteId": { + "type": "string", + "example": "Default" + }, + "enumTipoEntregaId": { + "type": "string", + "example": "EntregaAgendada" + }, + "eventoProdutoSelecionado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "enderecoEvento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac7bac971c6000a1704904" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json b/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json new file mode 100644 index 000000000..ff1f45c65 --- /dev/null +++ b/wake/utils/openapi/retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter.openapi.json @@ -0,0 +1,189 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/newsletter": { + "get": { + "summary": "Retorna lista de usuários cadastrados/descadastrados na newsletter", + "description": "Retorna lista de usuários cadastrados/descadastrados na newsletter (50 por página)", + "operationId": "retorna-lista-de-usuarios-cadastradosdescadastrados-na-newsletter", + "parameters": [ + { + "name": "ordenarPor", + "in": "query", + "description": "Tipo de ordenação", + "schema": { + "type": "string", + "enum": [ + "DataCadastro", + "DataAtualizacao" + ] + } + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos cadastros que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "status", + "in": "query", + "description": "Status do usuário", + "schema": { + "type": "boolean" + } + }, + { + "name": "doubleOptIn", + "in": "query", + "description": "DoubleOptIn aceito (verificar estado da configuração)", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"nome\": \"string\",\n \"email\": \"string\",\n \"sexo\": \"string\",\n \"status\": true,\n \"grupoInformacao\": [\n {\n \"nome\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "sexo": { + "type": "string", + "example": "string" + }, + "status": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de9b925c29e9001aac9006" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json b/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json new file mode 100644 index 000000000..3b9b6a30e --- /dev/null +++ b/wake/utils/openapi/retorna-loja-fisica-pelo-id.openapi.json @@ -0,0 +1,252 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}": { + "get": { + "summary": "Retorna Loja Física pelo Id", + "description": "Loja Física", + "operationId": "retorna-loja-fisica-pelo-id", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ddd": { + "type": "integer", + "example": 0, + "default": 0 + }, + "telefone": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoMaximoRetirada": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "textoComplementar": { + "type": "string", + "example": "string" + }, + "retirarNaLoja": { + "type": "boolean", + "example": true, + "default": true + }, + "latitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "longitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b999e6c7342b00761401c2" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json b/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json new file mode 100644 index 000000000..faf76133c --- /dev/null +++ b/wake/utils/openapi/retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao.openapi.json @@ -0,0 +1,168 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/estoque": { + "get": { + "summary": "Retorna o estoque total e o estoque por centro de distribuição", + "description": "Objeto com o estoque total e o estoque por centro de distribuição de um produto variante", + "operationId": "retorna-o-estoque-total-e-o-estoque-por-centro-de-distribuicao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"listProdutoVarianteCentroDistribuicaoEstoque\": [\n {\n \"centroDistribuicaoId\": 0,\n \"nome\": \"string\",\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "listProdutoVarianteCentroDistribuicaoEstoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4862956685300527c28db" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json new file mode 100644 index 000000000..db3609235 --- /dev/null +++ b/wake/utils/openapi/retorna-o-historico-de-situacoes-de-um-pedido.openapi.json @@ -0,0 +1,160 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/historicoSituacao": { + "get": { + "summary": "Retorna o histórico de situações de um pedido", + "description": "", + "operationId": "retorna-o-historico-de-situacoes-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Identificador do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"situacoes\": [\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"dataAtualizacao\": \"2022-09-01T13:25:07.718Z\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "situacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-09-01T13:25:07.718Z" + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:6310b4d82785aa001af2f690" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json new file mode 100644 index 000000000..7c17f5916 --- /dev/null +++ b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico-1.openapi.json @@ -0,0 +1,122 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/limiteCreditoPorEmail/{email}": { + "get": { + "summary": "Retorna o limite de crédito de um usuário específico", + "description": "Limite de crédito de um usuário específico", + "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico-1", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de93b9ce20a30356051482" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json new file mode 100644 index 000000000..a747e263d --- /dev/null +++ b/wake/utils/openapi/retorna-o-limite-de-credito-de-um-usuario-especifico.openapi.json @@ -0,0 +1,123 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/limiteCreditoPorUsuarioId/{usuarioId}": { + "get": { + "summary": "Retorna o limite de crédito de um usuário específico", + "description": "Limite de crédito de um usuário específico", + "operationId": "retorna-o-limite-de-credito-de-um-usuario-especifico", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de9343e07d3d009caf88a6" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json b/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json new file mode 100644 index 000000000..5f5b0567c --- /dev/null +++ b/wake/utils/openapi/retorna-o-parceiro-pelo-id.openapi.json @@ -0,0 +1,150 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{parceiroId}": { + "get": { + "summary": "Retorna o parceiro pelo id", + "description": "Parceiro encontrado", + "operationId": "retorna-o-parceiro-pelo-id", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb328562b1e00531bf637" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json b/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json new file mode 100644 index 000000000..f9e33488d --- /dev/null +++ b/wake/utils/openapi/retorna-o-parceiro-pelo-nome.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{nome}": { + "get": { + "summary": "Retorna o parceiro pelo nome", + "description": "Parceiro encontrado", + "operationId": "retorna-o-parceiro-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do parceiro", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb40668e01c003df9743c" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json b/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json new file mode 100644 index 000000000..562034fa5 --- /dev/null +++ b/wake/utils/openapi/retorna-o-portfolio-pelo-id.openapi.json @@ -0,0 +1,122 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}": { + "get": { + "summary": "Retorna o portfolio pelo id", + "description": "Portfolio encontrado", + "operationId": "retorna-o-portfolio-pelo-id", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef21394d3260096d7e47d" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json b/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json new file mode 100644 index 000000000..df5cc57eb --- /dev/null +++ b/wake/utils/openapi/retorna-o-portfolio-pelo-nome.openapi.json @@ -0,0 +1,121 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{nome}": { + "get": { + "summary": "Retorna o portfolio pelo nome", + "description": "Portfolio encontrado", + "operationId": "retorna-o-portfolio-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do portfolio que se deseja buscar", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef2ddb96cca009dc16e6e" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json b/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json new file mode 100644 index 000000000..63f76c7cd --- /dev/null +++ b/wake/utils/openapi/retorna-o-precode-e-precopor-de-um-produto.openapi.json @@ -0,0 +1,146 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/preco": { + "get": { + "summary": "Retorna o precoDe e precoPor de um produto", + "description": "Objeto com o precoDe e precoPor de um produto variante", + "operationId": "retorna-o-precode-e-precopor-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c46e8fc4be3400559ac9ae" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json new file mode 100644 index 000000000..8c50f32cc --- /dev/null +++ b/wake/utils/openapi/retorna-o-relatorio-de-receitas-de-um-determinado-periodo.openapi.json @@ -0,0 +1,198 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/receita": { + "get": { + "summary": "Retorna o relatório de receitas de um determinado período", + "description": "Relatório de receitas de um determinado período", + "operationId": "retorna-o-relatorio-de-receitas-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.736Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.736Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4203d0375900704b00f2" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json new file mode 100644 index 000000000..2b6b0c42d --- /dev/null +++ b/wake/utils/openapi/retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo.openapi.json @@ -0,0 +1,198 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/ticketMedio": { + "get": { + "summary": "Retorna o relatório de ticket médio de um determinado período", + "description": "Relatório de ticket médio de um determinado período", + "operationId": "retorna-o-relatorio-de-ticket-medio-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.739Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.739Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4238335a250013ebd023" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json b/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json new file mode 100644 index 000000000..85646d200 --- /dev/null +++ b/wake/utils/openapi/retorna-o-relatorio-de-transacoes-de-um-determinado-periodo.openapi.json @@ -0,0 +1,198 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/transacoes": { + "get": { + "summary": "Retorna o relatório de transações de um determinado período", + "description": "Relatório de transações de um determinado período", + "operationId": "retorna-o-relatorio-de-transacoes-de-um-determinado-periodo", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retornar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "tipoAgrupamento", + "in": "query", + "description": "Tipo de agrupamento dos pedidos (hora, dia, semana, mês, ano)", + "schema": { + "type": "string", + "enum": [ + "Hora", + "Dia", + "Semana", + "Mes", + "Ano" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoAgrupamento\": \"Hora\",\n \"dados\": [\n {\n \"data\": \"2022-06-17T11:14:38.743Z\",\n \"pedidosCaptados\": 0,\n \"pedidosPagos\": 0,\n \"pedidosEnviados\": 0,\n \"pedidosCancelados\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoAgrupamento": { + "type": "string", + "example": "Hora" + }, + "dados": { + "type": "array", + "items": { + "type": "object", + "properties": { + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.743Z" + }, + "pedidosCaptados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosPagos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosEnviados": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidosCancelados": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa4265f66d9b001a2145a3" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json new file mode 100644 index 000000000..136819389 --- /dev/null +++ b/wake/utils/openapi/retorna-o-saldo-de-um-usuario.openapi.json @@ -0,0 +1,133 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/contascorrentes/{email}": { + "get": { + "summary": "Retorna o saldo de um usuário", + "description": "", + "operationId": "retorna-o-saldo-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa27f6a5716d006d027578" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json new file mode 100644 index 000000000..c78adf599 --- /dev/null +++ b/wake/utils/openapi/retorna-o-ultimo-status-de-um-pedido.openapi.json @@ -0,0 +1,205 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/status": { + "get": { + "summary": "Retorna o último status de um pedido", + "description": "Último status do pedido", + "operationId": "retorna-o-ultimo-status-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"situacaoPedidoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.193Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.193Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"nomeTransportadora\": \"string\",\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"situacaoProdutoId\": 0,\n \"quantidade\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.193Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.193Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "nomeTransportadora": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb0eb3b2d02402aeeebedf" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json new file mode 100644 index 000000000..92eea626e --- /dev/null +++ b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas.openapi.json @@ -0,0 +1,111 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/midias": { + "get": { + "summary": "Retorna o xml com os dados de todas as mídias entre duas datas", + "description": "Xml com os dados das mídias entre duas datas", + "operationId": "retorna-o-xml-com-os-dados-de-todas-as-midias-entre-duas-datas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bda2506db2dc00311668ba" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json new file mode 100644 index 000000000..d91694fdd --- /dev/null +++ b/wake/utils/openapi/retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas.openapi.json @@ -0,0 +1,230 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/midias/{identificador}": { + "get": { + "summary": "Retorna o xml com os dados de uma mídia específicas entre duas datas", + "description": "Xml com os dados de uma mídia específicas entre duas datas", + "operationId": "retorna-o-xml-com-os-dados-de-uma-midia-especificas-entre-duas-datas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "identificador", + "in": "path", + "description": "Identificar da mídia (ex.: 7-CPA)", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"dias\": {\n \"diaMidiaApiModel\": [\n {\n \"dia\": \"2022-06-30T11:24:34.731Z\",\n \"investimento\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"pedidos\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"roi\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"receita\": {\n \"meta\": 0,\n \"realizado\": 0\n },\n \"visitas\": {\n \"meta\": 0,\n \"realizado\": 0\n }\n }\n ]\n },\n \"id\": 0,\n \"nome\": \"string\",\n \"tipo\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "dias": { + "type": "object", + "properties": { + "diaMidiaApiModel": { + "type": "array", + "items": { + "type": "object", + "properties": { + "dia": { + "type": "string", + "example": "2022-06-30T11:24:34.731Z" + }, + "investimento": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "pedidos": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "roi": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "receita": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "visitas": { + "type": "object", + "properties": { + "meta": { + "type": "integer", + "example": 0, + "default": 0 + }, + "realizado": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bda3695cd2a0001a9004fc" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json b/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json new file mode 100644 index 000000000..66fc43297 --- /dev/null +++ b/wake/utils/openapi/retorna-os-campos-de-cadastro-personalizado-existentes.openapi.json @@ -0,0 +1,144 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/camposcadastropersonalizado": { + "get": { + "summary": "Retorna os campos de cadastro personalizado existentes", + "description": "Campos de cadastro personalizado encontrados", + "operationId": "retorna-os-campos-de-cadastro-personalizado-existentes", + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"grupoInformacaoCadastralId\": 0,\n \"nome\": \"string\",\n \"tipo\": \"TextoLivre\",\n \"obrigatorio\": true,\n \"ordem\": 0,\n \"valorPreDefinido\": [\n {\n \"valoresDefinidosCampoGrupoInformacaoId\": 0,\n \"valor\": \"string\",\n \"ordem\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoInformacaoCadastralId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "TextoLivre" + }, + "obrigatorio": { + "type": "boolean", + "example": true, + "default": true + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPreDefinido": { + "type": "array", + "items": { + "type": "object", + "properties": { + "valoresDefinidosCampoGrupoInformacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "string", + "example": "string" + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dec853d52c65010d6da284" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json new file mode 100644 index 000000000..300b377cc --- /dev/null +++ b/wake/utils/openapi/retorna-os-dados-da-lista-de-desejos-de-um-usuario.openapi.json @@ -0,0 +1,130 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}/listaDesejos": { + "get": { + "summary": "Retorna os dados da lista de desejos de um usuário", + "description": "Dados da lista de desejos de um usuário", + "operationId": "retorna-os-dados-da-lista-de-desejos-de-um-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"dataAdicao\": \"2022-07-25T11:26:13.971Z\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAdicao": { + "type": "string", + "example": "2022-07-25T11:26:13.971Z" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dea5b1d78713001491e863" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json new file mode 100644 index 000000000..09ae746d6 --- /dev/null +++ b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-de-um-pedido.openapi.json @@ -0,0 +1,189 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento": { + "get": { + "summary": "Retorna os dados de rastreamento/nf de um pedido", + "description": "Lista de pedidos", + "operationId": "retorna-os-dados-de-rastreamentonf-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoRastreamentoId\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.200Z\",\n \"notaFiscal\": \"string\",\n \"serieNF\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.200Z\",\n \"urlNFE\": \"string\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.200Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoRastreamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "serieNF": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + }, + "urlNFE": { + "type": "string", + "example": "string" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.200Z" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb111fe2a40c0190687631" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json new file mode 100644 index 000000000..724cba691 --- /dev/null +++ b/wake/utils/openapi/retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido.openapi.json @@ -0,0 +1,207 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/rastreamento/produtos": { + "get": { + "summary": "Retorna os dados de rastreamento/nf dos produtos de um pedido", + "description": "Lista de pedidos", + "operationId": "retorna-os-dados-de-rastreamentonf-dos-produtos-de-um-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"rastreamentos\": [\n {\n \"pedidoRastreamentoProdutoId\": 0,\n \"quantidade\": 0,\n \"dataAtualizacao\": \"2022-06-28T11:18:19.238Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.238Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"transportadora\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"dataEntrega\": \"2022-06-28T11:18:19.238Z\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "rastreamentos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoRastreamentoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.238Z" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb2e7db8853603c36ae9bf" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json new file mode 100644 index 000000000..f44e8ec4d --- /dev/null +++ b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido.openapi.json @@ -0,0 +1,190 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/pedido/{pedidoId}": { + "get": { + "summary": "Retorna os dados de uma assinatura a partir do id do Pedido", + "description": "Assinatura de um determinado pedido", + "operationId": "retorna-os-dados-de-uma-assinatura-a-partir-do-id-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaPedidoId\": 0,\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"pedidoId\": 0,\n \"valor\": 0,\n \"data\": \"2022-06-08T11:32:39.571Z\",\n \"origemPedidoEnumId\": 0,\n \"produtoVarianteId\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-08T11:32:39.571Z" + }, + "origemPedidoEnumId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0b81da846fe01699b429d" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json new file mode 100644 index 000000000..165a67314 --- /dev/null +++ b/wake/utils/openapi/retorna-os-dados-de-uma-assinatura-especifica.openapi.json @@ -0,0 +1,226 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}": { + "get": { + "summary": "Retorna os dados de uma assinatura específica", + "description": "Detalhes de uma assinatura", + "operationId": "retorna-os-dados-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.154Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.154Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\",\n \"produtos\": [\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.154Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.154Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a71ec21c0501011e64c99b" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json b/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json new file mode 100644 index 000000000..a582d2d76 --- /dev/null +++ b/wake/utils/openapi/retorna-os-detalhes-da-transacao-de-um-pedido.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/transacoes/{transacaoId}": { + "get": { + "summary": "Retorna os detalhes da transação de um pedido", + "description": "Dados de transação do pedido", + "operationId": "retorna-os-detalhes-da-transacao-de-um-pedido", + "parameters": [ + { + "name": "transacaoId", + "in": "path", + "description": "Número da Transação que se deseja buscar os dados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb3025563588032bb623bc" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json b/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json new file mode 100644 index 000000000..4856d0732 --- /dev/null +++ b/wake/utils/openapi/retorna-os-detalhes-do-servico-de-frete.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/frete": { + "get": { + "summary": "Retorna os detalhes do serviço de frete", + "description": "Dados do serviço de frete do pedido", + "operationId": "retorna-os-detalhes-do-servico-de-frete", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar os dados", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb32ac1fb82e001474ef11" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json new file mode 100644 index 000000000..3d1abd109 --- /dev/null +++ b/wake/utils/openapi/retorna-os-erros-de-uma-assinatura-especifica.openapi.json @@ -0,0 +1,183 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/erros/{assinaturaId}": { + "get": { + "summary": "Retorna os erros de uma assinatura especifica", + "description": "Assinatura com erro na loja", + "operationId": "retorna-os-erros-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "id da Assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaErroId\": 0,\n \"assinaturaId\": 0,\n \"usuarioId\": \"string\",\n \"visualizado\": true,\n \"dataErro\": \"2022-06-08T11:32:39.566Z\",\n \"resolvido\": true,\n \"codigoAssinaturaErro\": 0,\n \"assinaturaErroNome\": \"string\",\n \"assinaturaErroDescricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaErroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "string", + "example": "string" + }, + "visualizado": { + "type": "boolean", + "example": true, + "default": true + }, + "dataErro": { + "type": "string", + "example": "2022-06-08T11:32:39.566Z" + }, + "resolvido": { + "type": "boolean", + "example": true, + "default": true + }, + "codigoAssinaturaErro": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaErroNome": { + "type": "string", + "example": "string" + }, + "assinaturaErroDescricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0b66b878668005c2953e9" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json b/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json new file mode 100644 index 000000000..f6daa27ea --- /dev/null +++ b/wake/utils/openapi/retorna-os-produtos-de-uma-assinatura-especifica.openapi.json @@ -0,0 +1,177 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/{assinaturaId}/produtos": { + "get": { + "summary": "Retorna os produtos de uma assinatura específica", + "description": "Produtos de uma assinatura", + "operationId": "retorna-os-produtos-de-uma-assinatura-especifica", + "parameters": [ + { + "name": "assinaturaId", + "in": "path", + "description": "Id da assinatura", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaProdutoId\": 0,\n \"assinaturaId\": 0,\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"quantidade\": 0,\n \"valor\": 0,\n \"removido\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a72176e5800c00e7e6b712" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..b81e30d11 --- /dev/null +++ b/wake/utils/openapi/retorna-os-produtos-de-uma-tabela-de-precos.openapi.json @@ -0,0 +1,158 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}/produtos": { + "get": { + "summary": "Retorna os produtos de uma tabela de preços", + "description": "Lista de produtos de uma tabela de preços", + "operationId": "retorna-os-produtos-de-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tabelaPrecoProdutoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"sku\": \"string\",\n \"produtoVarianteId\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoProdutoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a97ac5887702643ffec2" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json b/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json new file mode 100644 index 000000000..328fd8568 --- /dev/null +++ b/wake/utils/openapi/retorna-os-usuarios-pelo-id-do-parceiro.openapi.json @@ -0,0 +1,138 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{parceiroId}/usuarios": { + "get": { + "summary": "Retorna os usuários pelo id do parceiro", + "description": "Usuários encontrados", + "operationId": "retorna-os-usuarios-pelo-id-do-parceiro", + "parameters": [ + { + "name": "parceiroId", + "in": "path", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.775Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.775Z\",\n \"vinculoVitalicio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "email": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicial": { + "type": "string", + "example": "2022-06-30T11:24:34.775Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-30T11:24:34.775Z" + }, + "vinculoVitalicio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb43bba061200699c0766" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json b/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json new file mode 100644 index 000000000..23258f9ee --- /dev/null +++ b/wake/utils/openapi/retorna-os-usuarios-pelo-nome-do-parceiro.openapi.json @@ -0,0 +1,137 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/{nome}/usuarios": { + "get": { + "summary": "Retorna os usuários pelo nome do parceiro", + "description": "Usuários encontrados", + "operationId": "retorna-os-usuarios-pelo-nome-do-parceiro", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do parceiro", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"email\": \"string\",\n \"ativo\": true,\n \"dataInicial\": \"2022-06-30T11:24:34.778Z\",\n \"dataFinal\": \"2022-06-30T11:24:34.778Z\",\n \"vinculoVitalicio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "email": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "dataInicial": { + "type": "string", + "example": "2022-06-30T11:24:34.778Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-06-30T11:24:34.778Z" + }, + "vinculoVitalicio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb47d68e01c003df97796" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-produtos-por-seller.openapi.json b/wake/utils/openapi/retorna-produtos-por-seller.openapi.json new file mode 100644 index 000000000..20d086738 --- /dev/null +++ b/wake/utils/openapi/retorna-produtos-por-seller.openapi.json @@ -0,0 +1,526 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/produtos/{identificador}": { + "get": { + "summary": "Retorna produtos por Seller", + "description": "Lista de produtos", + "operationId": "retorna-produtos-por-seller", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o reseller", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um id interno da fstore ou a Razão social do Reseller", + "schema": { + "type": "string", + "enum": [ + "ResellerId", + "RazaoSocial" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "somenteValidos", + "in": "query", + "description": "Se deve retornar apenas produtos válidos (padrão: false)", + "schema": { + "type": "boolean" + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campos adicionais que se selecionados retornaram junto com o produto: Atacado, Estoque, Atributo, Informacao, TabelaPreo", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-18T11:04:10.596Z\",\n \"dataAtualizacao\": \"2022-07-18T11:04:10.596Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-18T11:04:10.596Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-18T11:04:10.596Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d5445d1946d7007b5759a1" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json b/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json new file mode 100644 index 000000000..4523f9204 --- /dev/null +++ b/wake/utils/openapi/retorna-se-o-produto-variante-esta-disponivel-ou-nao.openapi.json @@ -0,0 +1,126 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/disponibilidade": { + "get": { + "summary": "Retorna se o produto variante está disponível ou não", + "description": "", + "operationId": "retorna-se-o-produto-variante-esta-disponivel-ou-nao", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c46dc726fb0e001aac9680" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json b/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json new file mode 100644 index 000000000..e23d5df3a --- /dev/null +++ b/wake/utils/openapi/retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter.openapi.json @@ -0,0 +1,112 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/comunicacao": { + "get": { + "summary": "Retorna se o usuário ativou o recebimento de newsletter", + "description": "Retorna se o usuário ativou o recebimento de newsletter", + "operationId": "retorna-se-o-ususrio-ativou-o-recebimento-de-newsletter", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"recebimentoNewsletter\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "recebimentoNewsletter": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dea2cd9efd2a007503d9f5" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json new file mode 100644 index 000000000..b165c89a6 --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja.openapi.json @@ -0,0 +1,207 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtoavaliacao": { + "get": { + "summary": "Retorna todas as avaliações dos produtos variantes da loja", + "description": "Lista de avaliações de produtos", + "operationId": "retorna-todas-as-avaliacoes-dos-produtos-variantes-da-loja", + "parameters": [ + { + "name": "status", + "in": "query", + "description": "Referente ao status que libera a visualização da avaliação no site", + "schema": { + "type": "string", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-14T19:01:50.098Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoAvaliacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comentario": { + "type": "string", + "example": "string" + }, + "avaliacao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAvaliacao": { + "type": "string", + "example": "2022-07-14T19:01:50.098Z" + }, + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "status": { + "type": "string", + "example": "Pendente" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d0686406066a0085762de7" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json b/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json new file mode 100644 index 000000000..f7f2be29e --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-categorias-de-um-produto.openapi.json @@ -0,0 +1,213 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/categorias": { + "get": { + "summary": "Retorna todas as categorias de um produto", + "description": "Lista de categorias de um produto", + "operationId": "retorna-todas-as-categorias-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\",\n \"caminhoHierarquia\": \"string\",\n \"categoriaPrincipal\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + }, + "caminhoHierarquia": { + "type": "string", + "example": "string" + }, + "categoriaPrincipal": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c44b6585171d0013b584f1" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-categorias.openapi.json b/wake/utils/openapi/retorna-todas-as-categorias.openapi.json new file mode 100644 index 000000000..0fd0e2ddf --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-categorias.openapi.json @@ -0,0 +1,215 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias": { + "get": { + "summary": "Retorna todas as categorias", + "description": "Lista de categorias", + "operationId": "retorna-todas-as-categorias", + "parameters": [ + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "apenasReseller", + "in": "query", + "description": "Se será apresentado apenas Reseller", + "schema": { + "type": "boolean" + } + }, + { + "name": "apenasUltimoNivel", + "in": "query", + "description": "Se será apresentado apenas o último nível das categorias", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a9e825da84df002ec5bc83" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json new file mode 100644 index 000000000..5f7672033 --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-formas-de-pagamento-da-loja.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/formasPagamento": { + "get": { + "summary": "Retorna todas as formas de pagamento da loja", + "description": "Lista de formas de pagamento", + "operationId": "retorna-todas-as-formas-de-pagamento-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"formaPagamentoId\": 0,\n \"nome\": \"string\",\n \"nomeExibicao\": \"string\",\n \"descricao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeExibicao": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0a4f9f17cd2008820e6de" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json b/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json new file mode 100644 index 000000000..380b289e2 --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-informacoes-de-um-produto.openapi.json @@ -0,0 +1,152 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/informacoes": { + "get": { + "summary": "Retorna todas as informações de um produto", + "description": "Retorna todas as informações de um produto específico", + "operationId": "retorna-todas-as-informacoes-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c44079d5d89100930b2659" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json b/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json new file mode 100644 index 000000000..f30b3c19c --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-lojas-fisicas.openapi.json @@ -0,0 +1,263 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas": { + "get": { + "summary": "Retorna todas as Lojas Físicas", + "description": "Lista de Lojas Físicas", + "operationId": "retorna-todas-as-lojas-fisicas", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"lojaId\": 0,\n \"nome\": \"string\",\n \"ddd\": 0,\n \"telefone\": \"string\",\n \"email\": \"string\",\n \"cep\": \"string\",\n \"logradouro\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estadoId\": 0,\n \"prazoEntrega\": 0,\n \"prazoMaximoRetirada\": 0,\n \"ativo\": true,\n \"valido\": true,\n \"textoComplementar\": \"string\",\n \"retirarNaLoja\": true,\n \"latitude\": 0,\n \"longitude\": 0,\n \"centroDistribuicaoId\": 0,\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"prazoEntrega\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ddd": { + "type": "integer", + "example": 0, + "default": 0 + }, + "telefone": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoMaximoRetirada": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "textoComplementar": { + "type": "string", + "example": "string" + }, + "retirarNaLoja": { + "type": "boolean", + "example": true, + "default": true + }, + "latitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "longitude": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5ef5058633d00afe39f5a" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json b/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json new file mode 100644 index 000000000..bbb4f2a0b --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-situacoes-de-pedido-da-loja.openapi.json @@ -0,0 +1,116 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/situacoesPedido": { + "get": { + "summary": "Retorna todas as situações de pedido da loja", + "description": "Lista de situações de pedido", + "operationId": "retorna-todas-as-situacoes-de-pedido-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"situacaoPedidoId\": 0,\n \"nome\": \"string\",\n \"descricao\": \"string\",\n \"observacao\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "descricao": { + "type": "string", + "example": "string" + }, + "observacao": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c48b8c02a0f600140ba458" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json b/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json new file mode 100644 index 000000000..d9fda2aba --- /dev/null +++ b/wake/utils/openapi/retorna-todas-as-tabelas-de-precos.openapi.json @@ -0,0 +1,126 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos": { + "get": { + "summary": "Retorna todas as tabelas de preços", + "description": "Lista de tabelas de preços", + "operationId": "retorna-todas-as-tabelas-de-precos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.621Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.621Z\",\n \"ativo\": true,\n \"isSite\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicial": { + "type": "string", + "example": "2022-07-19T11:05:47.621Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-07-19T11:05:47.621Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isSite": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a6f38e22dc00626f5b0f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-atributos.openapi.json b/wake/utils/openapi/retorna-todos-os-atributos.openapi.json new file mode 100644 index 000000000..5ae7c861c --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-atributos.openapi.json @@ -0,0 +1,132 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/atributos": { + "get": { + "summary": "Retorna todos os atributos", + "description": "Lista de atributos", + "operationId": "retorna-todos-os-atributos", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "Selecao" + }, + "tipoExibicao": { + "type": "string", + "example": "Combo" + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{}" + } + }, + "schema": { + "type": "object", + "properties": {} + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0e06fbddf01005ea57c98" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json b/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json new file mode 100644 index 000000000..1a53be277 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-centros-de-distribuicao.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/centrosdistribuicao": { + "get": { + "summary": "Retorna todos os centros de distribuição", + "description": "Lista de centros de distribuição", + "operationId": "retorna-todos-os-centros-de-distribuicao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": 0,\n \"nome\": \"string\",\n \"cep\": 0,\n \"padrao\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "integer", + "example": 0, + "default": 0 + }, + "padrao": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa21284a1124092dea1ced" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json b/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json new file mode 100644 index 000000000..8cc52e93b --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-fabricantes.openapi.json @@ -0,0 +1,156 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes": { + "get": { + "summary": "Retorna todos os fabricantes", + "description": "Lista de fabricantes", + "operationId": "retorna-todos-os-fabricantes", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b05f788599140131516021" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json b/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json new file mode 100644 index 000000000..e306d4773 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-parceiros-com-pedidos.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros/comPedidos": { + "get": { + "summary": "Retorna todos os parceiros com pedidos", + "description": "Lista de parceiros com pedidos", + "operationId": "retorna-todos-os-parceiros-com-pedidos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdb286323e93009dc43328" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json b/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json new file mode 100644 index 000000000..6f52fbd77 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-parceiros.openapi.json @@ -0,0 +1,141 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/parceiros": { + "get": { + "summary": "Retorna todos os parceiros", + "description": "Lista de parceiros", + "operationId": "retorna-todos-os-parceiros", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"parceiroId\": 0,\n \"marketPlaceId\": 0,\n \"nome\": \"string\",\n \"tabelaPrecoId\": 0,\n \"portfolioId\": 0,\n \"tipoEscopo\": \"Aberto\",\n \"ativo\": true,\n \"isMarketPlace\": true,\n \"origem\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "parceiroId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "marketPlaceId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEscopo": { + "type": "string", + "example": "Aberto" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "origem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bdab39d6cd5b00a493f0bc" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json b/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json new file mode 100644 index 000000000..f0637829f --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-portfolios.openapi.json @@ -0,0 +1,113 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios": { + "get": { + "summary": "Retorna todos os portfolios", + "description": "Lista de portfolios", + "operationId": "retorna-todos-os-portfolios", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"portfolioId\": 0,\n \"nome\": \"string\",\n \"ativo\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "portfolioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bedb30a15e8e013e95ec4a" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json b/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json new file mode 100644 index 000000000..13003c356 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco.openapi.json @@ -0,0 +1,187 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/precos": { + "get": { + "summary": "Retorna todos os preços referente ao produto variante, incluindo os preços de tabela de preço", + "description": "Preços do produto variante informado", + "operationId": "retorna-todos-os-precos-referente-ao-produto-variante-incluindo-os-precos-de-tabela-de-preco", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"precosTabelaPreco\": [\n {\n \"produtoVarianteId\": 0,\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precosTabelaPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c49a3c454fa5009df9d5c0" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json b/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json new file mode 100644 index 000000000..3f2208162 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-produtos-1.openapi.json @@ -0,0 +1,222 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/alteracoes": { + "get": { + "summary": "Retorna todos os produtos", + "description": "Lista de preços e estoque de produtos que sofreram alterações", + "operationId": "retorna-todos-os-produtos-1", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "alteradosPartirDe", + "in": "query", + "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"disponivel\": true,\n \"valido\": true,\n \"exibirSite\": true,\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c3301d254560009866ae5f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-produtos.openapi.json b/wake/utils/openapi/retorna-todos-os-produtos.openapi.json new file mode 100644 index 000000000..2f15f2b60 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-produtos.openapi.json @@ -0,0 +1,558 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos": { + "get": { + "summary": "Retorna todos os produtos", + "description": "Lista de produtos", + "operationId": "retorna-todos-os-produtos", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "categorias", + "in": "query", + "description": "Lista de categorias que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as categorias", + "schema": { + "type": "string" + } + }, + { + "name": "fabricantes", + "in": "query", + "description": "Lista de fabricantes que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "centrosDistribuicao", + "in": "query", + "description": "Lista de centros de distribuição que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará produtos de todos os cd's", + "schema": { + "type": "string" + } + }, + { + "name": "alteradosPartirDe", + "in": "query", + "description": "Retorna apenas os produtos que sofreram alguma alteração a partir da data/hora informada. Formato: aaaa-mm-dd hh:mm:ss com no máximo 48 horas de antecedência", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "somenteValidos", + "in": "query", + "description": "Retorna apenas os produtos que estão marcados como válido", + "schema": { + "type": "boolean" + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campos adicionais que se selecionados retornaram junto com o produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.472Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.472Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}\n ]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.472Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.472Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "consumo": { + "type": "object", + "properties": { + "quantidadeDias": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enviarEmail": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "prazoValidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c2d48988437b002e0ccb21" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json b/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json new file mode 100644 index 000000000..54f611231 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-sellers-da-loja.openapi.json @@ -0,0 +1,137 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers": { + "get": { + "summary": "Retorna todos os Sellers da loja", + "description": "Lista de resellers", + "operationId": "retorna-todos-os-sellers-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d1a2e941f16f047b130439" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json b/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json new file mode 100644 index 000000000..abe73a354 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-tipos-de-eventos.openapi.json @@ -0,0 +1,210 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento": { + "get": { + "summary": "Retorna todos os tipos de eventos", + "description": "Lista de tipos de evento", + "operationId": "retorna-todos-os-tipos-de-eventos", + "parameters": [ + { + "name": "ativo", + "in": "query", + "description": "Status do tipo de evento", + "schema": { + "type": "boolean" + } + }, + { + "name": "disponivel", + "in": "query", + "description": "Se o tipo de evento está disponível", + "schema": { + "type": "boolean" + } + }, + { + "name": "nome", + "in": "query", + "description": "Nome do tipo de evento", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipoEntrega": { + "type": "string", + "example": "EntregaAgendada" + }, + "tipoDisponibilizacao": { + "type": "string", + "example": "DisponibilizacaoDeCreditos" + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "corHexTituloInformacoes": { + "type": "string", + "example": "string" + }, + "corHexCorpoInformacoes": { + "type": "string", + "example": "string" + }, + "numeroAbasInformacoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroLocaisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "tipoBeneficiarioFrete": { + "type": "string", + "example": "DonodaLista" + }, + "caminhoLogoEvento": { + "type": "string", + "example": "string" + }, + "caminhoSubTemplate": { + "type": "string", + "example": "string" + }, + "sugestaoProdutos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ced411426e4d0434332791" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json b/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json new file mode 100644 index 000000000..02e19d251 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-os-usuarios.openapi.json @@ -0,0 +1,285 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios": { + "get": { + "summary": "Retorna todos os usuários", + "description": "Lista de usuários", + "operationId": "retorna-todos-os-usuarios", + "parameters": [ + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final da data de criação do usuário que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro de data", + "schema": { + "type": "string", + "enum": [ + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "aprovado", + "in": "query", + "description": "Status de aprovação", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:16:24.396Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:16:24.396Z\",\n \"dataAtualizacao\": \"2022-07-20T17:16:24.396Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:16:24.396Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d8388ed91557004d74d91f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json b/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json new file mode 100644 index 000000000..c3f2646c5 --- /dev/null +++ b/wake/utils/openapi/retorna-todos-ranges-de-cep-que-essa-loja-atende.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/lojasFisicas/{lojaFisicaId}/rangeCep": { + "get": { + "summary": "Retorna todos ranges de cep que essa loja atende", + "description": "Lista de Ranges de Ceps de uma Loja Física", + "operationId": "retorna-todos-ranges-de-cep-que-essa-loja-atende", + "parameters": [ + { + "name": "lojaFisicaId", + "in": "path", + "description": "Id da loja física", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"rangeCepId\": 0,\n \"nome\": \"string\",\n \"cepInicial\": \"string\",\n \"cepFinal\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "rangeCepId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cepInicial": { + "type": "string", + "example": "string" + }, + "cepFinal": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b9b8ac72164000486fc745" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json new file mode 100644 index 000000000..5a33d034d --- /dev/null +++ b/wake/utils/openapi/retorna-um-atacarejo-pelo-id.openapi.json @@ -0,0 +1,175 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/atacarejo/{produtoVarianteAtacadoId}": { + "get": { + "summary": "Retorna um Atacarejo pelo Id", + "description": "Atacarejo", + "operationId": "retorna-um-atacarejo-pelo-id", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtoVarianteAtacadoId", + "in": "path", + "description": "Id do Atacarejo", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"produtoVarianteAtacadoId\": 0,\n \"precoAtacado\": 0,\n \"quantidade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteAtacadoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoAtacado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c4951df0ecbb00469ed2f6" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json b/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json new file mode 100644 index 000000000..e5f58120b --- /dev/null +++ b/wake/utils/openapi/retorna-um-atributo-especifico.openapi.json @@ -0,0 +1,155 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/atributos/{nome}": { + "get": { + "summary": "Retorna um atributo específico", + "description": "Atributo encontrado", + "operationId": "retorna-um-atributo-especifico", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do atributo", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"nome\": \"string\",\n \"tipo\": \"Selecao\",\n \"tipoExibicao\": \"Combo\",\n \"prioridade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "nome": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "Selecao" + }, + "tipoExibicao": { + "type": "string", + "example": "Combo" + }, + "prioridade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a0eeb071a9a9003ad8bc0b" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json b/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json new file mode 100644 index 000000000..ae59ee233 --- /dev/null +++ b/wake/utils/openapi/retorna-um-contrato-de-frete.openapi.json @@ -0,0 +1,217 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}": { + "get": { + "summary": "Retorna um contrato de frete", + "description": "Frete encontrado", + "operationId": "retorna-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "volumeMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "linkRastreamento": { + "type": "string", + "example": "string" + }, + "ehAssinatura": { + "type": "boolean", + "example": true, + "default": true + }, + "larguraMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alturaMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimentoMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limiteMaximoDimensoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limitePesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tempoMinimoDespacho": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoProdutos": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d16f06cf210036e5b3f1" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-evento-especifico.openapi.json b/wake/utils/openapi/retorna-um-evento-especifico.openapi.json new file mode 100644 index 000000000..151441c0c --- /dev/null +++ b/wake/utils/openapi/retorna-um-evento-especifico.openapi.json @@ -0,0 +1,322 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}": { + "get": { + "summary": "Retorna um evento especifico", + "description": "Lista de produtos variantes vinculados aos tipo de evento", + "operationId": "retorna-um-evento-especifico", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"eventoId\": 0,\n \"tipoEventoId\": 0,\n \"userId\": 0,\n \"enderecoEntregaId\": 0,\n \"data\": \"2022-06-17T11:14:38.758Z\",\n \"dataCriacao\": \"2022-06-17T11:14:38.758Z\",\n \"titulo\": \"string\",\n \"url\": \"string\",\n \"disponivel\": true,\n \"diasDepoisEvento\": 0,\n \"diasAntesEvento\": 0,\n \"urlLogoEvento\": \"string\",\n \"urlCapaEvento\": \"string\",\n \"proprietarioEvento\": \"string\",\n \"abaInfo01Habilitado\": true,\n \"textoInfo01\": \"string\",\n \"conteudoInfo01\": \"string\",\n \"abaInfo02Habilitado\": true,\n \"textoInfo02\": \"string\",\n \"conteudoInfo02\": \"string\",\n \"abaMensagemHabilitado\": true,\n \"fotos\": \"string\",\n \"enumTipoListaPresenteId\": \"Default\",\n \"enumTipoEntregaId\": \"EntregaAgendada\",\n \"eventoProdutoSelecionado\": [\n {\n \"eventoId\": 0,\n \"produtoVarianteId\": 0,\n \"recebidoForaLista\": true,\n \"removido\": true\n }\n ],\n \"enderecoEvento\": [\n {\n \"enderecoEventoId\": 0,\n \"eventoId\": 0,\n \"nome\": \"string\",\n \"cep\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "userId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enderecoEntregaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:38.758Z" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:38.758Z" + }, + "titulo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "diasDepoisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "diasAntesEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlLogoEvento": { + "type": "string", + "example": "string" + }, + "urlCapaEvento": { + "type": "string", + "example": "string" + }, + "proprietarioEvento": { + "type": "string", + "example": "string" + }, + "abaInfo01Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo01": { + "type": "string", + "example": "string" + }, + "conteudoInfo01": { + "type": "string", + "example": "string" + }, + "abaInfo02Habilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "textoInfo02": { + "type": "string", + "example": "string" + }, + "conteudoInfo02": { + "type": "string", + "example": "string" + }, + "abaMensagemHabilitado": { + "type": "boolean", + "example": true, + "default": true + }, + "fotos": { + "type": "string", + "example": "string" + }, + "enumTipoListaPresenteId": { + "type": "string", + "example": "Default" + }, + "enumTipoEntregaId": { + "type": "string", + "example": "EntregaAgendada" + }, + "eventoProdutoSelecionado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "recebidoForaLista": { + "type": "boolean", + "example": true, + "default": true + }, + "removido": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "enderecoEvento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "eventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac8191b902e4002d17e805" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json new file mode 100644 index 000000000..4dd661f3e --- /dev/null +++ b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-id.openapi.json @@ -0,0 +1,165 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes/{fabricanteId}": { + "get": { + "summary": "Retorna um fabricante específico pelo id", + "description": "Fabricante encontrado", + "operationId": "retorna-um-fabricante-especifico-pelo-id", + "parameters": [ + { + "name": "fabricanteId", + "in": "path", + "description": "Id do fabricante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b08432c9c44d008e7522b8" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json new file mode 100644 index 000000000..394937aa1 --- /dev/null +++ b/wake/utils/openapi/retorna-um-fabricante-especifico-pelo-nome.openapi.json @@ -0,0 +1,164 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fabricantes/{nome}": { + "get": { + "summary": "Retorna um fabricante específico pelo nome", + "description": "Fabricante encontrado", + "operationId": "retorna-um-fabricante-especifico-pelo-nome", + "parameters": [ + { + "name": "nome", + "in": "path", + "description": "Nome do fabricante", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"fabricanteId\": 0,\n \"ativo\": true,\n \"nome\": \"string\",\n \"urlLogoTipo\": \"string\",\n \"urlLink\": \"string\",\n \"urlCarrossel\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "fabricanteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "urlLogoTipo": { + "type": "string", + "example": "string" + }, + "urlLink": { + "type": "string", + "example": "string" + }, + "urlCarrossel": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b08b25c8ee0a02277e6dd3" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json b/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json new file mode 100644 index 000000000..89c2531a4 --- /dev/null +++ b/wake/utils/openapi/retorna-um-pedido-especifico.openapi.json @@ -0,0 +1,1219 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}": { + "get": { + "summary": "Retorna um pedido especifico", + "description": "Pedido encontrado", + "operationId": "retorna-um-pedido-especifico", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-17T11:14:39.010Z\",\n \"dataPagamento\": \"2022-06-17T11:14:39.010Z\",\n \"dataUltimaAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-17T11:14:39.010Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-17T11:14:39.010Z\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.010Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-17T11:14:39.011Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-17T11:14:39.011Z\",\n \"ate\": \"2022-06-17T11:14:39.011Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-17T11:14:39.011Z\",\n \"dataUltimoStatus\": \"2022-06-17T11:14:39.011Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-17T11:14:39.011Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.010Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "ate": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-17T11:14:39.011Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac84cdc617f9008362d02b" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json b/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json new file mode 100644 index 000000000..c14f14114 --- /dev/null +++ b/wake/utils/openapi/retorna-um-produto-buscando-pelo-seu-identificador.openapi.json @@ -0,0 +1,530 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}": { + "get": { + "summary": "Retorna um produto buscando pelo seu identificador", + "description": "Método responsável por retornar um produto específico buscando pelo seu identificador, que pode ser um sku ou produto variante. O tipo do identificador pode ser definido no campo tipoIdentificador. Também é possível informar quais informações adicionais devem ser retornadas na consulta utilizando o campo campos adicionais.", + "operationId": "retorna-um-produto-buscando-pelo-seu-identificador", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId", + "ProdutoId" + ] + } + }, + { + "name": "camposAdicionais", + "in": "query", + "description": "Campo opcional que define quais dados extras devem ser retornados em conjunto com os dados básicos do produto, valores aceitos: Atacado, Estoque, Atributo , Informacao, TabelaPreco", + "schema": { + "type": "array", + "items": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"produtoVarianteId\": 0,\n \"produtoId\": 0,\n \"idPaiExterno\": \"string\",\n \"idVinculoExterno\": \"string\",\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"nomeProdutoPai\": \"string\",\n \"urlProduto\": \"string\",\n \"exibirMatrizAtributos\": \"Sim\",\n \"contraProposta\": true,\n \"fabricante\": \"string\",\n \"autor\": \"string\",\n \"editora\": \"string\",\n \"colecao\": \"string\",\n \"genero\": \"string\",\n \"precoCusto\": 0,\n \"precoDe\": 0,\n \"precoPor\": 0,\n \"fatorMultiplicadorPreco\": 0,\n \"prazoEntrega\": 0,\n \"valido\": true,\n \"exibirSite\": true,\n \"freteGratis\": \"Sempre\",\n \"trocaGratis\": true,\n \"peso\": 0,\n \"altura\": 0,\n \"comprimento\": 0,\n \"largura\": 0,\n \"garantia\": 0,\n \"isTelevendas\": true,\n \"ean\": \"string\",\n \"localizacaoEstoque\": \"string\",\n \"listaAtacado\": [\n {\n \"precoPor\": 0,\n \"quantidade\": 0\n }\n ],\n \"estoque\": [\n {\n \"estoqueFisico\": 0,\n \"estoqueReservado\": 0,\n \"centroDistribuicaoId\": 0,\n \"alertaEstoque\": 0\n }\n ],\n \"atributos\": [\n {\n \"tipoAtributo\": \"Selecao\",\n \"isFiltro\": true,\n \"nome\": \"string\",\n \"valor\": \"string\",\n \"exibir\": true\n }\n ],\n \"quantidadeMaximaCompraUnidade\": 0,\n \"quantidadeMinimaCompraUnidade\": 0,\n \"condicao\": \"Novo\",\n \"informacoes\": [\n {\n \"informacaoId\": 0,\n \"titulo\": \"string\",\n \"texto\": \"string\",\n \"tipoInformacao\": \"Informacoes\"\n }\n ],\n \"tabelasPreco\": [\n {\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"precoDe\": 0,\n \"precoPor\": 0\n }\n ],\n \"dataCriacao\": \"2022-07-04T11:52:02.490Z\",\n \"dataAtualizacao\": \"2022-07-04T11:52:02.490Z\",\n \"urlVideo\": \"string\",\n \"spot\": true,\n \"paginaProduto\": true,\n \"marketplace\": true,\n \"somenteParceiros\": true,\n \"reseller\": {\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n },\n \"buyBox\": true,\n \"consumo\": {\n \"quantidadeDias\": 0,\n \"enviarEmail\": true\n },\n \"prazoValidade\": 0\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "idPaiExterno": { + "type": "string", + "example": "string" + }, + "idVinculoExterno": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "nomeProdutoPai": { + "type": "string", + "example": "string" + }, + "urlProduto": { + "type": "string", + "example": "string" + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "contraProposta": { + "type": "boolean", + "example": true, + "default": true + }, + "fabricante": { + "type": "string", + "example": "string" + }, + "autor": { + "type": "string", + "example": "string" + }, + "editora": { + "type": "string", + "example": "string" + }, + "colecao": { + "type": "string", + "example": "string" + }, + "genero": { + "type": "string", + "example": "string" + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "fatorMultiplicadorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirSite": { + "type": "boolean", + "example": true, + "default": true + }, + "freteGratis": { + "type": "string", + "example": "Sempre" + }, + "trocaGratis": { + "type": "boolean", + "example": true, + "default": true + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "altura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "largura": { + "type": "integer", + "example": 0, + "default": 0 + }, + "garantia": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isTelevendas": { + "type": "boolean", + "example": true, + "default": true + }, + "ean": { + "type": "string", + "example": "string" + }, + "localizacaoEstoque": { + "type": "string", + "example": "string" + }, + "listaAtacado": { + "type": "array", + "items": { + "type": "object", + "properties": { + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "estoque": { + "type": "array", + "items": { + "type": "object", + "properties": { + "estoqueFisico": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estoqueReservado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alertaEstoque": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoAtributo": { + "type": "string", + "example": "Selecao" + }, + "isFiltro": { + "type": "boolean", + "example": true, + "default": true + }, + "nome": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + }, + "exibir": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeMinimaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "condicao": { + "type": "string", + "example": "Novo" + }, + "informacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "informacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "titulo": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "tipoInformacao": { + "type": "string", + "example": "Informacoes" + } + } + } + }, + "tabelasPreco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "precoDe": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-04T11:52:02.490Z" + }, + "urlVideo": { + "type": "string", + "example": "string" + }, + "spot": { + "type": "boolean", + "example": true, + "default": true + }, + "paginaProduto": { + "type": "boolean", + "example": true, + "default": true + }, + "marketplace": { + "type": "boolean", + "example": true, + "default": true + }, + "somenteParceiros": { + "type": "boolean", + "example": true, + "default": true + }, + "reseller": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "consumo": { + "type": "object", + "properties": { + "quantidadeDias": { + "type": "integer", + "example": 0, + "default": 0 + }, + "enviarEmail": { + "type": "boolean", + "example": true, + "default": true + } + } + }, + "prazoValidade": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "\tProduto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c32871981a41006f6cb2b9" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json b/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json new file mode 100644 index 000000000..0cfc1e0c4 --- /dev/null +++ b/wake/utils/openapi/retorna-um-rastreamento-de-produto.openapi.json @@ -0,0 +1,241 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/{pedidoId}/produtos/{produtoVarianteId}/rastreamento/{pedidoRastreamentoProdutoId}": { + "get": { + "summary": "Retorna um rastreamento de produto", + "description": "Rastreamento de produto encontrado", + "operationId": "retorna-um-rastreamento-de-produto", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Número do pedido que se deseja buscar", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "produtoVarianteId", + "in": "path", + "description": "Id do Produto Variante", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "pedidoRastreamentoProdutoId", + "in": "path", + "description": "Id do Pedido Rastreamento Produto", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"pedidoRastreamentoProdutoId\": 0,\n \"pedidoId\": 0,\n \"produtoVarianteId\": 0,\n \"pedidoProdutoId\": 0,\n \"dataInclusao\": \"2022-06-28T11:18:19.225Z\",\n \"dataAlteracao\": \"2022-06-28T11:18:19.225Z\",\n \"notaFiscal\": \"string\",\n \"cfop\": 0,\n \"dataEnviado\": \"2022-06-28T11:18:19.225Z\",\n \"chaveAcessoNFE\": \"string\",\n \"rastreamento\": \"string\",\n \"urlRastreamento\": \"string\",\n \"quantidade\": 0,\n \"urlNFE\": \"string\",\n \"serieNFE\": \"string\",\n \"tipoPostagem\": \"string\",\n \"centroDistribuicao\": \"string\",\n \"transportadora\": \"string\",\n \"dataEntrega\": \"2022-06-28T11:18:19.225Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "pedidoRastreamentoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataInclusao": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "dataAlteracao": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "notaFiscal": { + "type": "string", + "example": "string" + }, + "cfop": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataEnviado": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + }, + "chaveAcessoNFE": { + "type": "string", + "example": "string" + }, + "rastreamento": { + "type": "string", + "example": "string" + }, + "urlRastreamento": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "urlNFE": { + "type": "string", + "example": "string" + }, + "serieNFE": { + "type": "string", + "example": "string" + }, + "tipoPostagem": { + "type": "string", + "example": "string" + }, + "centroDistribuicao": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "dataEntrega": { + "type": "string", + "example": "2022-06-28T11:18:19.225Z" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb2a3456172300834e2406" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json b/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json new file mode 100644 index 000000000..e69e83a71 --- /dev/null +++ b/wake/utils/openapi/retorna-um-seller-especifico-da-loja-1.openapi.json @@ -0,0 +1,146 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/{resellerId}": { + "get": { + "summary": "Retorna um Seller específico da loja", + "description": "Reseller específico", + "operationId": "retorna-um-seller-especifico-da-loja-1", + "parameters": [ + { + "name": "resellerId", + "in": "path", + "description": "Valor único utilizado para identificar o seller", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d1c003daaa690093b8c56a" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json b/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json new file mode 100644 index 000000000..6bd5761c8 --- /dev/null +++ b/wake/utils/openapi/retorna-um-seller-especifico-da-loja.openapi.json @@ -0,0 +1,134 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/resellers/token": { + "get": { + "summary": "Retorna um Seller específico da loja", + "description": "Reseller específico", + "operationId": "retorna-um-seller-especifico-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"resellerId\": 0,\n \"razaoSocial\": \"string\",\n \"centroDistribuicaoId\": 0,\n \"ativo\": true,\n \"ativacaoAutomaticaProdutos\": true,\n \"autonomia\": true,\n \"buyBox\": true,\n \"nomeMarketPlace\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "ativacaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "autonomia": { + "type": "boolean", + "example": true, + "default": true + }, + "buyBox": { + "type": "boolean", + "example": true, + "default": true + }, + "nomeMarketPlace": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d1bf8e04ae690047164e3f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json b/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json new file mode 100644 index 000000000..5070e5ea5 --- /dev/null +++ b/wake/utils/openapi/retorna-um-tipo-de-evento-especifico.openapi.json @@ -0,0 +1,193 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}": { + "get": { + "summary": "Retorna um tipo de evento especifico", + "description": "Tipo evento buscado", + "operationId": "retorna-um-tipo-de-evento-especifico", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tipoEventoId\": 0,\n \"nome\": \"string\",\n \"tipoEntrega\": \"EntregaAgendada\",\n \"tipoDisponibilizacao\": \"DisponibilizacaoDeCreditos\",\n \"permitirRemocaoAutomaticaProdutos\": true,\n \"corHexTituloInformacoes\": \"string\",\n \"corHexCorpoInformacoes\": \"string\",\n \"numeroAbasInformacoes\": 0,\n \"quantidadeDiasParaEventoExpirar\": 0,\n \"numeroLocaisEvento\": 0,\n \"ativo\": true,\n \"disponivel\": true,\n \"tipoBeneficiarioFrete\": \"DonodaLista\",\n \"caminhoLogoEvento\": \"string\",\n \"caminhoSubTemplate\": \"string\",\n \"sugestaoProdutos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "tipoEntrega": { + "type": "string", + "example": "EntregaAgendada" + }, + "tipoDisponibilizacao": { + "type": "string", + "example": "DisponibilizacaoDeCreditos" + }, + "permitirRemocaoAutomaticaProdutos": { + "type": "boolean", + "example": true, + "default": true + }, + "corHexTituloInformacoes": { + "type": "string", + "example": "string" + }, + "corHexCorpoInformacoes": { + "type": "string", + "example": "string" + }, + "numeroAbasInformacoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidadeDiasParaEventoExpirar": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroLocaisEvento": { + "type": "integer", + "example": 0, + "default": 0 + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "disponivel": { + "type": "boolean", + "example": true, + "default": true + }, + "tipoBeneficiarioFrete": { + "type": "string", + "example": "DonodaLista" + }, + "caminhoLogoEvento": { + "type": "string", + "example": "string" + }, + "caminhoSubTemplate": { + "type": "string", + "example": "string" + }, + "sugestaoProdutos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ced188dfc5120a1a83da98" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json new file mode 100644 index 000000000..1b61af73d --- /dev/null +++ b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cnpj.openapi.json @@ -0,0 +1,235 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/cnpj/{cnpj}": { + "get": { + "summary": "Retorna um usuário específico pelo cnpj", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-cnpj", + "parameters": [ + { + "name": "cnpj", + "in": "path", + "description": "CNPJ do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.476Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.476Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.476Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.476Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d8443170fd50003ff16f5f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json new file mode 100644 index 000000000..e80d2b842 --- /dev/null +++ b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-cpf.openapi.json @@ -0,0 +1,235 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/cpf/{cpf}": { + "get": { + "summary": "Retorna um usuário específico pelo cpf", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-cpf", + "parameters": [ + { + "name": "cpf", + "in": "path", + "description": "CPF do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.473Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.473Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.473Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.473Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d843d937827c001a37f151" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json new file mode 100644 index 000000000..7761e88f6 --- /dev/null +++ b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-e-mail.openapi.json @@ -0,0 +1,235 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/email/{email}": { + "get": { + "summary": "Retorna um usuário específico pelo e-mail", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-e-mail", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d841c858ce1d0044ba8fc3" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json new file mode 100644 index 000000000..6ddb66fd6 --- /dev/null +++ b/wake/utils/openapi/retorna-um-usuario-especifico-pelo-id.openapi.json @@ -0,0 +1,236 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/usuarioId/{usuarioId}": { + "get": { + "summary": "Retorna um usuário específico pelo id", + "description": "Usuário encontrado", + "operationId": "retorna-um-usuario-especifico-pelo-id", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"usuarioId\": 0,\n \"bloqueado\": true,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-07-20T17:54:12.466Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-07-20T17:54:12.466Z\",\n \"dataAtualizacao\": \"2022-07-20T17:54:12.466Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"avatar\": \"string\",\n \"ip\": \"string\",\n \"aprovado\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "bloqueado": { + "type": "boolean", + "example": true, + "default": true + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-07-20T17:54:12.466Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "avatar": { + "type": "string", + "example": "string" + }, + "ip": { + "type": "string", + "example": "string" + }, + "aprovado": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d99025f01e4d002f3a1731" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json b/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json new file mode 100644 index 000000000..03d3e7546 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador.openapi.json @@ -0,0 +1,206 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/erp/{id}": { + "get": { + "summary": "Retorna uma categoria específica utilizando o id do erp como identificador", + "description": "Categoria encontrada", + "operationId": "retorna-uma-categoria-especifica-utilizando-o-id-do-erp-como-identificador", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + }, + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa0c992bc4a200a3366ee1" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json b/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json new file mode 100644 index 000000000..deb5a8eae --- /dev/null +++ b/wake/utils/openapi/retorna-uma-categoria-especifica.openapi.json @@ -0,0 +1,206 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/categorias/{id}": { + "get": { + "summary": "Retorna uma categoria específica", + "description": "Categoria encontrada", + "operationId": "retorna-uma-categoria-especifica", + "parameters": [ + { + "name": "id", + "in": "path", + "description": "Id da categoria", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + }, + { + "name": "hierarquia", + "in": "query", + "description": "Hierarquia da categoria", + "schema": { + "type": "boolean" + } + }, + { + "name": "somenteFilhos", + "in": "query", + "description": "Se será apresentado somente categorias filhas", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"id\": 0,\n \"nome\": \"string\",\n \"categoriaPaiId\": 0,\n \"categoriaERPId\": \"string\",\n \"ativo\": true,\n \"isReseller\": true,\n \"exibirMatrizAtributos\": \"Sim\",\n \"quantidadeMaximaCompraUnidade\": 0,\n \"valorMinimoCompra\": 0,\n \"exibeMenu\": true,\n \"urlHotSite\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "categoriaPaiId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "categoriaERPId": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isReseller": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMatrizAtributos": { + "type": "string", + "example": "Sim" + }, + "quantidadeMaximaCompraUnidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoCompra": { + "type": "integer", + "example": 0, + "default": 0 + }, + "exibeMenu": { + "type": "boolean", + "example": true, + "default": true + }, + "urlHotSite": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa055a959bb4009b9ebcba" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json b/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json new file mode 100644 index 000000000..591a8bbcd --- /dev/null +++ b/wake/utils/openapi/retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido.openapi.json @@ -0,0 +1,204 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/pedidos/{pedidoId}/cotacoes": { + "get": { + "summary": "Retorna uma cotação de frete para o carrinho do pedido", + "description": "Objeto com as cotações de frete", + "operationId": "retorna-uma-cotacao-de-frete-para-o-carrinho-do-pedido", + "parameters": [ + { + "name": "pedidoId", + "in": "path", + "description": "Id do pedido", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + }, + { + "name": "forcarCotacaoTodosCDs", + "in": "query", + "description": "Força cotação de todos os CD's.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"id\": \"string\",\n \"nome\": \"string\",\n \"prazo\": 0,\n \"tabelaFreteId\": \"string\",\n \"tipo\": \"string\",\n \"valor\": 0,\n \"centroDistribuicao\": 0,\n \"produtos\": [\n {\n \"produtoVarianteId\": 0,\n \"valor\": 0,\n \"centroDistribuicaoId\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tabelaFreteId": { + "type": "string", + "example": "string" + }, + "tipo": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:63d40199f6dd870085f457fe" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json b/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json new file mode 100644 index 000000000..a476f8aaf --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-com-os-dados-das-assinaturas.openapi.json @@ -0,0 +1,251 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas": { + "get": { + "summary": "Retorna uma lista com os dados das assinaturas", + "description": "Lista com assinaturas", + "operationId": "retorna-uma-lista-com-os-dados-das-assinaturas", + "parameters": [ + { + "name": "situacaoAssinatura", + "in": "query", + "description": "Situação da assinatura", + "schema": { + "type": "string", + "enum": [ + "Ativa", + "Pausada", + "Cancelada" + ] + } + }, + { + "name": "periodoRecorrencia", + "in": "query", + "description": "Período de recorrência", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "dataInicialProximaRecorrencia", + "in": "query", + "description": "Data inicial da próxima recorrência", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalProximaRecorrencia", + "in": "query", + "description": "Data final da próxima recorrencia", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataInicialCancelamento", + "in": "query", + "description": "Data inicial de cancelamento", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinalCancelamento", + "in": "query", + "description": "Data final de cancelamento", + "schema": { + "type": "string", + "format": "date" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"assinaturaId\": 0,\n \"usuarioId\": 0,\n \"dataProximoPedido\": \"2022-06-13T11:13:55.131Z\",\n \"periodoRecorrencia\": \"string\",\n \"situacaoAssinatura\": \"Ativa\",\n \"dataAssinatura\": \"2022-06-13T11:13:55.131Z\",\n \"grupoAssinatura\": \"string\",\n \"enderecoId\": 0,\n \"usuarioCartaoCreditoId\": 0,\n \"cupom\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataProximoPedido": { + "type": "string", + "example": "2022-06-13T11:13:55.131Z" + }, + "periodoRecorrencia": { + "type": "string", + "example": "string" + }, + "situacaoAssinatura": { + "type": "string", + "example": "Ativa" + }, + "dataAssinatura": { + "type": "string", + "example": "2022-06-13T11:13:55.131Z" + }, + "grupoAssinatura": { + "type": "string", + "example": "string" + }, + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioCartaoCreditoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupom": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "\t{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a71e408531cf0116289180" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json new file mode 100644 index 000000000..ed1baac90 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/documento/{documento}/pedidos": { + "get": { + "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", + "description": "Retorna lista contendo os Id's dos pedidos do usuário", + "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario-1", + "parameters": [ + { + "name": "documento", + "in": "path", + "description": "Documento (CPF ou CNPJ) do usuário cujos pedidos devem ser selecionados. Utilizar apenas números, sem caracteres especiais", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoDocumento", + "in": "query", + "description": "Define se o documento informado é um CPF ou um CNPJ", + "schema": { + "type": "string", + "enum": [ + "Cpf", + "Cnpj" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "string" + }, + "rel": { + "type": "string", + "example": "string" + }, + "method": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de9fe86b05db02773d3a7b" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json new file mode 100644 index 000000000..9512d5613 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario.openapi.json @@ -0,0 +1,135 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/pedidos": { + "get": { + "summary": "Retorna uma lista contendo o id dos pedidos de um usuário", + "description": "Retorna lista contendo os Id's dos pedidos do usuário", + "operationId": "retorna-uma-lista-contendo-o-id-dos-pedidos-de-um-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário cujos pedidos devem ser selecionados", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"pedidoId\": 0,\n \"links\": [\n {\n \"href\": \"string\",\n \"rel\": \"string\",\n \"method\": \"string\"\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "links": { + "type": "array", + "items": { + "type": "object", + "properties": { + "href": { + "type": "string", + "example": "string" + }, + "rel": { + "type": "string", + "example": "string" + }, + "method": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de9eecdd8ea90037ba6dac" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json new file mode 100644 index 000000000..4b8e4f492 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado.openapi.json @@ -0,0 +1,228 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/avaliacoes": { + "get": { + "summary": "Retorna uma lista de avaliações referente ao identificador informado", + "description": "Lista de avaliações de produtos", + "operationId": "retorna-uma-lista-de-avaliacoes-referente-ao-identificador-informado", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "status", + "in": "query", + "description": "Referente ao status que libera a visualização da avaliação no site = ['Pendente', 'NaoAprovado', 'Aprovado']", + "schema": { + "type": "string", + "enum": [ + "Pendente", + "NaoAprovado", + "Aprovado" + ] + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"produtoAvaliacaoId\": 0,\n \"comentario\": \"string\",\n \"avaliacao\": 0,\n \"usuarioId\": 0,\n \"dataAvaliacao\": \"2022-07-05T11:54:29.823Z\",\n \"nome\": \"string\",\n \"email\": \"string\",\n \"status\": \"Pendente\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "produtoAvaliacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comentario": { + "type": "string", + "example": "string" + }, + "avaliacao": { + "type": "integer", + "example": 0, + "default": 0 + }, + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "dataAvaliacao": { + "type": "string", + "example": "2022-07-05T11:54:29.823Z" + }, + "nome": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "status": { + "type": "string", + "example": "Pendente" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c491a0321dcc00476abb30" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json new file mode 100644 index 000000000..d1146e6d8 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-detalhes-de-um-contrato-de-frete.openapi.json @@ -0,0 +1,195 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes/{freteId}/detalhes": { + "get": { + "summary": "Retorna uma lista de detalhes de um contrato de frete", + "description": "Lista de detalhes de frete", + "operationId": "retorna-uma-lista-de-detalhes-de-um-contrato-de-frete", + "parameters": [ + { + "name": "freteId", + "in": "path", + "description": "Id do contrato de frete", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"freteId\": 0,\n \"cepInicial\": 0,\n \"cepFinal\": 0,\n \"variacoesFreteDetalhe\": [\n {\n \"pesoInicial\": 0,\n \"pesoFinal\": 0,\n \"valorFrete\": 0,\n \"prazoEntrega\": 0,\n \"valorPreco\": 0,\n \"valorPeso\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cepInicial": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cepFinal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "variacoesFreteDetalhe": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pesoInicial": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoFinal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEntrega": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPreco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorPeso": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0d3c93b7a6b014fcbfeea" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json new file mode 100644 index 000000000..a5d313d70 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario.openapi.json @@ -0,0 +1,160 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/enderecos": { + "get": { + "summary": "Retorna uma lista de endereços de um usuário pelo e-mail do usuário", + "description": "Retorna usuário encontrado", + "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-e-mail-do-usuario", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeEndereco": { + "type": "string", + "example": "string" + }, + "rua": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "utilizadoUltimoPedido": { + "type": "boolean", + "example": true, + "default": true + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62daac9ece40ec00a5a65a44" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json new file mode 100644 index 000000000..232278225 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{usuarioId}/enderecos": { + "get": { + "summary": "Retorna uma lista de endereços de um usuário pelo id do usuário", + "description": "Retorna usuário encontrado", + "operationId": "retorna-uma-lista-de-enderecos-de-um-usuario-pelo-id-do-usuario", + "parameters": [ + { + "name": "usuarioId", + "in": "path", + "description": "Id do usuário", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"enderecoId\": 0,\n \"nomeEndereco\": \"string\",\n \"rua\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"cep\": \"string\",\n \"utilizadoUltimoPedido\": true,\n \"pais\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "enderecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeEndereco": { + "type": "string", + "example": "string" + }, + "rua": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "utilizadoUltimoPedido": { + "type": "boolean", + "example": true, + "default": true + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62dad4e0c63a6b0060b401bc" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json new file mode 100644 index 000000000..fdc066421 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-fretes.openapi.json @@ -0,0 +1,208 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/fretes": { + "get": { + "summary": "Retorna uma lista de fretes", + "description": "Lista de fretes", + "operationId": "retorna-uma-lista-de-fretes", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"freteId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"volumeMaximo\": 0,\n \"pesoCubado\": 0,\n \"entregaAgendadaConfiguracaoId\": 0,\n \"linkRastreamento\": \"string\",\n \"ehAssinatura\": true,\n \"larguraMaxima\": 0,\n \"alturaMaxima\": 0,\n \"comprimentoMaximo\": 0,\n \"limiteMaximoDimensoes\": 0,\n \"limitePesoCubado\": 0,\n \"tempoMinimoDespacho\": 0,\n \"centroDistribuicaoId\": 0,\n \"valorMinimoProdutos\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "volumeMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "entregaAgendadaConfiguracaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "linkRastreamento": { + "type": "string", + "example": "string" + }, + "ehAssinatura": { + "type": "boolean", + "example": true, + "default": true + }, + "larguraMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "alturaMaxima": { + "type": "integer", + "example": 0, + "default": 0 + }, + "comprimentoMaximo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limiteMaximoDimensoes": { + "type": "integer", + "example": 0, + "default": 0 + }, + "limitePesoCubado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tempoMinimoDespacho": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorMinimoProdutos": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b0a6283b94840120ec907e" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json new file mode 100644 index 000000000..1fe1eb719 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-grupos-de-personalizacao.openapi.json @@ -0,0 +1,149 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/grupospersonalizacao": { + "get": { + "summary": "Retorna uma lista de Grupos de Personalização", + "description": "Lista de Grupos de Personalização", + "operationId": "retorna-uma-lista-de-grupos-de-personalizacao", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"grupoPersonalizacaoId\": 0,\n \"nome\": \"string\",\n \"ativo\": true,\n \"obrigatorio\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoPersonalizacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "obrigatorio": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5bb6ad8135202d40e7db6" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json new file mode 100644 index 000000000..bde6ad449 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-imagens-de-um-produto.openapi.json @@ -0,0 +1,169 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/imagens": { + "get": { + "summary": "Retorna uma lista de imagens de um produto", + "description": "Lista de imagens vinculadas a um produtos", + "operationId": "retorna-uma-lista-de-imagens-de-um-produto", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + }, + { + "name": "produtosIrmaos", + "in": "query", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"idImagem\": 0,\n \"nomeArquivo\": \"string\",\n \"url\": \"string\",\n \"ordem\": 0,\n \"estampa\": true,\n \"exibirMiniatura\": true\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "idImagem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeArquivo": { + "type": "string", + "example": "string" + }, + "url": { + "type": "string", + "example": "string" + }, + "ordem": { + "type": "integer", + "example": 0, + "default": 0 + }, + "estampa": { + "type": "boolean", + "example": true, + "default": true + }, + "exibirMiniatura": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c468bf652a13003566a311" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json new file mode 100644 index 000000000..5ef99bc9a --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento.openapi.json @@ -0,0 +1,1280 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/formaPagamento/{formasPagamento}": { + "get": { + "summary": "Retorna uma lista de pedido baseado nas formas de pagamento", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-baseado-nas-formas-de-pagamento", + "parameters": [ + { + "name": "formasPagamento", + "in": "path", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3)", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "situacoesPedido", + "in": "query", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.169Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.169Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.169Z\",\n \"ate\": \"2022-06-28T11:18:19.169Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.169Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.169Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.169Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.169Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb0dadb323c1002b595c79" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json new file mode 100644 index 000000000..723a239e7 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos.openapi.json @@ -0,0 +1,1288 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/situacaoPedido/{situacoesPedido}": { + "get": { + "summary": "Retorna uma lista de pedido baseado nas situações de pedidos", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-baseado-nas-situacoes-de-pedidos", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "formasPagamento", + "in": "query", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "situacoesPedido", + "in": "path", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "apenasAssinaturas", + "in": "query", + "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.146Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.146Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.146Z\",\n \"ate\": \"2022-06-28T11:18:19.146Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.146Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.146Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.146Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.146Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb0b3f0e1e7e0046b3e6f6" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json new file mode 100644 index 000000000..7ef76245c --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas.openapi.json @@ -0,0 +1,1311 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos": { + "get": { + "summary": "Retorna uma lista de pedido na ordem decrescente dentro do limite de datas passadas", + "description": "Lista de pedidos", + "operationId": "retorna-uma-lista-de-pedido-na-ordem-decrescente-dentro-do-limite-de-datas-passadas", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos pedidos que deverão retornar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos pedidos que deverão retonar (aaaa-mm-dd hh:mm:ss)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "enumTipoFiltroData", + "in": "query", + "description": "Tipo de filtro da data (Ordenação \"desc\" - padrão: DataPedido)", + "schema": { + "type": "string", + "enum": [ + "DataPedido", + "DataAprovacao", + "DataModificacaoStatus", + "DataAlteracao", + "DataCriacao" + ] + } + }, + { + "name": "situacoesPedido", + "in": "query", + "description": "Lista de situações que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as situações", + "schema": { + "type": "string" + } + }, + { + "name": "formasPagamento", + "in": "query", + "description": "Lista de formas de pagamento que deverão retornar (lista separada por \",\" ex.: 1,2,3), caso vazio retornará todas as formas de pagamento", + "schema": { + "type": "string" + } + }, + { + "name": "pagina", + "in": "query", + "description": "Página da lista (padrão: 1)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "quantidadeRegistros", + "in": "query", + "description": "Quantidade de registros que deverão retornar (max: 50)", + "schema": { + "type": "integer", + "format": "int32" + } + }, + { + "name": "email", + "in": "query", + "description": "Deverá retornar apenas pedidos realizados pelo usuário com o e-mail passado", + "schema": { + "type": "string" + } + }, + { + "name": "valido", + "in": "query", + "description": "Deverá retornar apenas pedidos válidos, inválidos ou todos (caso não seja informado)", + "schema": { + "type": "boolean" + } + }, + { + "name": "sku", + "in": "query", + "description": "Deverá retornar apenas pedidos que o produto de determinado sku foi comprado", + "schema": { + "type": "string" + } + }, + { + "name": "apenasAssinaturas", + "in": "query", + "description": "Quando passado o valor true, deverá retornar apenas pedidos de assinatura. Quando falso, deverá retornar todos os pedidos.", + "schema": { + "type": "boolean" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"tipoRastreamentoPedido\": \"SemRastreamento\",\n \"transacaoId\": 0,\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"dataPagamento\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimaAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"valorFrete\": 0,\n \"valorTotalPedido\": 0,\n \"valorDesconto\": 0,\n \"valorDebitoCC\": 0,\n \"cupomDesconto\": \"string\",\n \"marketPlacePedidoId\": \"string\",\n \"marketPlacePedidoSiteId\": \"string\",\n \"canalId\": 0,\n \"canalNome\": \"string\",\n \"canalOrigem\": \"string\",\n \"retiradaLojaId\": 0,\n \"isPedidoEvento\": true,\n \"usuario\": {\n \"usuarioId\": 0,\n \"grupoInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ],\n \"tipoPessoa\": \"Fisica\",\n \"origemContato\": \"Google\",\n \"tipoSexo\": \"Undefined\",\n \"nome\": \"string\",\n \"cpf\": \"string\",\n \"email\": \"string\",\n \"rg\": \"string\",\n \"telefoneResidencial\": \"string\",\n \"telefoneCelular\": \"string\",\n \"telefoneComercial\": \"string\",\n \"dataNascimento\": \"2022-06-28T11:18:19.095Z\",\n \"razaoSocial\": \"string\",\n \"cnpj\": \"string\",\n \"inscricaoEstadual\": \"string\",\n \"responsavel\": \"string\",\n \"dataCriacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"revendedor\": true,\n \"listaInformacaoCadastral\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"pedidoEndereco\": [\n {\n \"tipo\": \"Entrega\",\n \"nome\": \"string\",\n \"endereco\": \"string\",\n \"numero\": \"string\",\n \"complemento\": \"string\",\n \"referencia\": \"string\",\n \"cep\": \"string\",\n \"tipoLogradouro\": \"string\",\n \"logradouro\": \"string\",\n \"bairro\": \"string\",\n \"cidade\": \"string\",\n \"estado\": \"string\",\n \"pais\": \"string\"\n }\n ],\n \"frete\": {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"referenciaConector\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"retiradaLojaId\": 0,\n \"centrosDistribuicao\": [\n {\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"servico\": {\n \"servicoId\": 0,\n \"nome\": \"string\",\n \"transportadora\": \"string\",\n \"prazo\": 0,\n \"servicoNome\": \"string\",\n \"preco\": 0,\n \"servicoTransporte\": 0,\n \"codigo\": 0,\n \"servicoMeta\": \"string\",\n \"custo\": 0,\n \"token\": \"string\"\n },\n \"retiradaAgendada\": {\n \"lojaId\": 0,\n \"retiradaData\": \"2022-06-28T11:18:19.095Z\",\n \"retiradaPeriodo\": \"string\",\n \"nome\": \"string\",\n \"documento\": \"string\",\n \"codigoRetirada\": \"string\"\n },\n \"agendamento\": {\n \"de\": \"2022-06-28T11:18:19.095Z\",\n \"ate\": \"2022-06-28T11:18:19.095Z\"\n },\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n },\n \"itens\": [\n {\n \"produtoVarianteId\": 0,\n \"sku\": \"string\",\n \"nome\": \"string\",\n \"quantidade\": 0,\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"isBrinde\": true,\n \"valorAliquota\": 0,\n \"isMarketPlace\": true,\n \"precoPor\": 0,\n \"desconto\": 0,\n \"totais\": {\n \"precoCusto\": 0,\n \"precoVenda\": 0,\n \"precoPor\": 0,\n \"desconto\": 0\n },\n \"ajustes\": [\n {\n \"tipo\": \"Frete\",\n \"valor\": 0,\n \"observacao\": \"string\",\n \"nome\": \"string\"\n }\n ],\n \"centroDistribuicao\": [\n {\n \"centroDistribuicaoId\": 0,\n \"quantidade\": 0,\n \"situacaoProdutoId\": 0,\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0\n }\n ],\n \"valoresAdicionais\": [\n {\n \"tipo\": \"Acrescimo\",\n \"origem\": \"string\",\n \"texto\": \"string\",\n \"valor\": 0\n }\n ],\n \"atributos\": [\n {\n \"produtoVarianteAtributoValor\": \"string\",\n \"produtoVarianteAtributoNome\": \"string\"\n }\n ],\n \"embalagens\": [\n {\n \"tipoEmbalagemId\": 0,\n \"nomeTipoEmbalagem\": \"string\",\n \"mensagem\": \"string\",\n \"valor\": 0,\n \"descricao\": \"string\"\n }\n ],\n \"personalizacoes\": [\n {\n \"nomePersonalizacao\": \"string\",\n \"valorPersonalizacao\": \"string\",\n \"valor\": 0\n }\n ],\n \"frete\": [\n {\n \"quantidade\": 0,\n \"freteContratoId\": 0,\n \"freteContrato\": \"string\",\n \"valorFreteEmpresa\": 0,\n \"valorFreteCliente\": 0,\n \"peso\": 0,\n \"pesoCobrado\": 0,\n \"volume\": 0,\n \"volumeCobrado\": 0,\n \"prazoEnvio\": 0,\n \"prazoEnvioTexto\": \"string\",\n \"centroDistribuicaoId\": 0\n }\n ],\n \"dadosProdutoEvento\": {\n \"tipoPresenteRecebimento\": \"None\"\n },\n \"formulas\": [\n {\n \"chaveAjuste\": \"string\",\n \"valor\": 0,\n \"nome\": \"string\",\n \"expressao\": \"string\",\n \"expressaoInterpretada\": \"string\",\n \"endPoint\": \"string\"\n }\n ],\n \"seller\": {\n \"sellerId\": 0,\n \"sellerNome\": \"string\",\n \"sellerPedidoId\": 0\n }\n }\n ],\n \"assinatura\": [\n {\n \"assinaturaId\": 0,\n \"grupoAssinaturaId\": 0,\n \"tipoPeriodo\": \"string\",\n \"tempoPeriodo\": 0,\n \"percentualDesconto\": 0\n }\n ],\n \"pagamento\": [\n {\n \"formaPagamentoId\": 0,\n \"numeroParcelas\": 0,\n \"valorParcela\": 0,\n \"valorDesconto\": 0,\n \"valorJuros\": 0,\n \"valorTotal\": 0,\n \"boleto\": {\n \"urlBoleto\": \"string\",\n \"codigoDeBarras\": \"string\"\n },\n \"cartaoCredito\": [\n {\n \"numeroCartao\": \"string\",\n \"nomeTitular\": \"string\",\n \"dataValidade\": \"string\",\n \"codigoSeguranca\": \"string\",\n \"documentoCartaoCredito\": \"string\",\n \"token\": \"string\",\n \"info\": \"string\",\n \"bandeira\": \"string\"\n }\n ],\n \"pagamentoStatus\": [\n {\n \"numeroAutorizacao\": \"string\",\n \"numeroComprovanteVenda\": \"string\",\n \"dataAtualizacao\": \"2022-06-28T11:18:19.095Z\",\n \"dataUltimoStatus\": \"2022-06-28T11:18:19.095Z\",\n \"adquirente\": \"string\",\n \"tid\": \"string\"\n }\n ],\n \"informacoesAdicionais\": [\n {\n \"chave\": \"string\",\n \"valor\": \"string\"\n }\n ]\n }\n ],\n \"observacao\": [\n {\n \"observacao\": \"string\",\n \"usuario\": \"string\",\n \"data\": \"2022-06-28T11:18:19.095Z\",\n \"publica\": true\n }\n ],\n \"valorCreditoFidelidade\": 0,\n \"valido\": true,\n \"valorSubTotalSemDescontos\": 0,\n \"pedidoSplit\": [\n 0\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoRastreamentoPedido": { + "type": "string", + "example": "SemRastreamento" + }, + "transacaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataPagamento": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataUltimaAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "valorFrete": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotalPedido": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDebitoCC": { + "type": "integer", + "example": 0, + "default": 0 + }, + "cupomDesconto": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoId": { + "type": "string", + "example": "string" + }, + "marketPlacePedidoSiteId": { + "type": "string", + "example": "string" + }, + "canalId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "canalNome": { + "type": "string", + "example": "string" + }, + "canalOrigem": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isPedidoEvento": { + "type": "boolean", + "example": true, + "default": true + }, + "usuario": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + }, + "tipoPessoa": { + "type": "string", + "example": "Fisica" + }, + "origemContato": { + "type": "string", + "example": "Google" + }, + "tipoSexo": { + "type": "string", + "example": "Undefined" + }, + "nome": { + "type": "string", + "example": "string" + }, + "cpf": { + "type": "string", + "example": "string" + }, + "email": { + "type": "string", + "example": "string" + }, + "rg": { + "type": "string", + "example": "string" + }, + "telefoneResidencial": { + "type": "string", + "example": "string" + }, + "telefoneCelular": { + "type": "string", + "example": "string" + }, + "telefoneComercial": { + "type": "string", + "example": "string" + }, + "dataNascimento": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "razaoSocial": { + "type": "string", + "example": "string" + }, + "cnpj": { + "type": "string", + "example": "string" + }, + "inscricaoEstadual": { + "type": "string", + "example": "string" + }, + "responsavel": { + "type": "string", + "example": "string" + }, + "dataCriacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "revendedor": { + "type": "boolean", + "example": true, + "default": true + }, + "listaInformacaoCadastral": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "pedidoEndereco": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Entrega" + }, + "nome": { + "type": "string", + "example": "string" + }, + "endereco": { + "type": "string", + "example": "string" + }, + "numero": { + "type": "string", + "example": "string" + }, + "complemento": { + "type": "string", + "example": "string" + }, + "referencia": { + "type": "string", + "example": "string" + }, + "cep": { + "type": "string", + "example": "string" + }, + "tipoLogradouro": { + "type": "string", + "example": "string" + }, + "logradouro": { + "type": "string", + "example": "string" + }, + "bairro": { + "type": "string", + "example": "string" + }, + "cidade": { + "type": "string", + "example": "string" + }, + "estado": { + "type": "string", + "example": "string" + }, + "pais": { + "type": "string", + "example": "string" + } + } + } + }, + "frete": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "referenciaConector": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "retiradaLojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "centrosDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "servico": { + "type": "object", + "properties": { + "servicoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "transportadora": { + "type": "string", + "example": "string" + }, + "prazo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoNome": { + "type": "string", + "example": "string" + }, + "preco": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoTransporte": { + "type": "integer", + "example": 0, + "default": 0 + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "servicoMeta": { + "type": "string", + "example": "string" + }, + "custo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "token": { + "type": "string", + "example": "string" + } + } + }, + "retiradaAgendada": { + "type": "object", + "properties": { + "lojaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "retiradaData": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "retiradaPeriodo": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "documento": { + "type": "string", + "example": "string" + }, + "codigoRetirada": { + "type": "string", + "example": "string" + } + } + }, + "agendamento": { + "type": "object", + "properties": { + "de": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "ate": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "itens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sku": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isBrinde": { + "type": "boolean", + "example": true, + "default": true + }, + "valorAliquota": { + "type": "integer", + "example": 0, + "default": 0 + }, + "isMarketPlace": { + "type": "boolean", + "example": true, + "default": true + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "totais": { + "type": "object", + "properties": { + "precoCusto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoVenda": { + "type": "integer", + "example": 0, + "default": 0 + }, + "precoPor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "desconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + }, + "ajustes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Frete" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "observacao": { + "type": "string", + "example": "string" + }, + "nome": { + "type": "string", + "example": "string" + } + } + } + }, + "centroDistribuicao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoProdutoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "valoresAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipo": { + "type": "string", + "example": "Acrescimo" + }, + "origem": { + "type": "string", + "example": "string" + }, + "texto": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "atributos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteAtributoValor": { + "type": "string", + "example": "string" + }, + "produtoVarianteAtributoNome": { + "type": "string", + "example": "string" + } + } + } + }, + "embalagens": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEmbalagemId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeTipoEmbalagem": { + "type": "string", + "example": "string" + }, + "mensagem": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "descricao": { + "type": "string", + "example": "string" + } + } + } + }, + "personalizacoes": { + "type": "array", + "items": { + "type": "object", + "properties": { + "nomePersonalizacao": { + "type": "string", + "example": "string" + }, + "valorPersonalizacao": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "frete": { + "type": "array", + "items": { + "type": "object", + "properties": { + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContratoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "freteContrato": { + "type": "string", + "example": "string" + }, + "valorFreteEmpresa": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorFreteCliente": { + "type": "integer", + "example": 0, + "default": 0 + }, + "peso": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pesoCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volume": { + "type": "integer", + "example": 0, + "default": 0 + }, + "volumeCobrado": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvio": { + "type": "integer", + "example": 0, + "default": 0 + }, + "prazoEnvioTexto": { + "type": "string", + "example": "string" + }, + "centroDistribuicaoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "dadosProdutoEvento": { + "type": "object", + "properties": { + "tipoPresenteRecebimento": { + "type": "string", + "example": "None" + } + } + }, + "formulas": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chaveAjuste": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "expressao": { + "type": "string", + "example": "string" + }, + "expressaoInterpretada": { + "type": "string", + "example": "string" + }, + "endPoint": { + "type": "string", + "example": "string" + } + } + } + }, + "seller": { + "type": "object", + "properties": { + "sellerId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "sellerNome": { + "type": "string", + "example": "string" + }, + "sellerPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + }, + "assinatura": { + "type": "array", + "items": { + "type": "object", + "properties": { + "assinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "tipoPeriodo": { + "type": "string", + "example": "string" + }, + "tempoPeriodo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "percentualDesconto": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + }, + "pagamento": { + "type": "array", + "items": { + "type": "object", + "properties": { + "formaPagamentoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "numeroParcelas": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorParcela": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorDesconto": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorJuros": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valorTotal": { + "type": "integer", + "example": 0, + "default": 0 + }, + "boleto": { + "type": "object", + "properties": { + "urlBoleto": { + "type": "string", + "example": "string" + }, + "codigoDeBarras": { + "type": "string", + "example": "string" + } + } + }, + "cartaoCredito": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroCartao": { + "type": "string", + "example": "string" + }, + "nomeTitular": { + "type": "string", + "example": "string" + }, + "dataValidade": { + "type": "string", + "example": "string" + }, + "codigoSeguranca": { + "type": "string", + "example": "string" + }, + "documentoCartaoCredito": { + "type": "string", + "example": "string" + }, + "token": { + "type": "string", + "example": "string" + }, + "info": { + "type": "string", + "example": "string" + }, + "bandeira": { + "type": "string", + "example": "string" + } + } + } + }, + "pagamentoStatus": { + "type": "array", + "items": { + "type": "object", + "properties": { + "numeroAutorizacao": { + "type": "string", + "example": "string" + }, + "numeroComprovanteVenda": { + "type": "string", + "example": "string" + }, + "dataAtualizacao": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "dataUltimoStatus": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "adquirente": { + "type": "string", + "example": "string" + }, + "tid": { + "type": "string", + "example": "string" + } + } + } + }, + "informacoesAdicionais": { + "type": "array", + "items": { + "type": "object", + "properties": { + "chave": { + "type": "string", + "example": "string" + }, + "valor": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "observacao": { + "type": "array", + "items": { + "type": "object", + "properties": { + "observacao": { + "type": "string", + "example": "string" + }, + "usuario": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-28T11:18:19.095Z" + }, + "publica": { + "type": "boolean", + "example": true, + "default": true + } + } + } + }, + "valorCreditoFidelidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valido": { + "type": "boolean", + "example": true, + "default": true + }, + "valorSubTotalSemDescontos": { + "type": "integer", + "example": 0, + "default": 0 + }, + "pedidoSplit": { + "type": "array", + "items": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bae3b9b8853603c36aa0ac" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json new file mode 100644 index 000000000..267be5679 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao.openapi.json @@ -0,0 +1,155 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { + "get": { + "summary": "Retorna uma lista de produtos vinculados a um Grupo de Personalização", + "description": "Lista de produtos de um Grupo de Personalização", + "operationId": "retorna-uma-lista-de-produtos-vinculados-a-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoId\": 0,\n \"nome\": \"string\",\n \"alias\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "alias": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5eaba411a4f0490f2ff6f" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json new file mode 100644 index 000000000..f1ae7e096 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um.openapi.json @@ -0,0 +1,114 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/limiteCredito": { + "get": { + "summary": "Retorna uma lista de usuários com o limite de credito de cada um", + "description": "Limite de crédito que estão vinculados aos usuários", + "operationId": "retorna-uma-lista-de-usuarios-com-o-limite-de-credito-de-cada-um", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"usuarioId\": 0,\n \"valor\": 0,\n \"saldo\": 0\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "usuarioId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "valor": { + "type": "integer", + "example": 0, + "default": 0 + }, + "saldo": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de92ea30c2cc001a8dab2c" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json b/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json new file mode 100644 index 000000000..7075c74fa --- /dev/null +++ b/wake/utils/openapi/retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro.openapi.json @@ -0,0 +1,102 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/usuarios/{email}/parceiros": { + "get": { + "summary": "Retorna uma lista de vínculos entre usuário e parceiro", + "description": "", + "operationId": "retorna-uma-lista-de-vinculos-entre-usuario-e-parceiro", + "parameters": [ + { + "name": "email", + "in": "path", + "description": "E-mail do usuário", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62de8551112bba03862e8816" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json b/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json new file mode 100644 index 000000000..d493fe95e --- /dev/null +++ b/wake/utils/openapi/retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro.openapi.json @@ -0,0 +1,181 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/produtos": { + "get": { + "summary": "Retorna uma listagem com dados dos produtos mais vendidos pela loja ou parceiro", + "description": "Produtos Mais Vendidos", + "operationId": "retorna-uma-listagem-com-dados-dos-produtos-mais-vendidos-pela-loja-ou-parceiro", + "parameters": [ + { + "name": "dataInicial", + "in": "query", + "description": "Data inicial dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "dataFinal", + "in": "query", + "description": "Data final dos produtos mais vendidos que deverão retonar (aaaa-mm-dd)", + "schema": { + "type": "string", + "format": "date" + } + }, + { + "name": "parceiroId", + "in": "query", + "description": "Id do parceiro", + "schema": { + "type": "integer", + "format": "int32" + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"produtoVarianteId\": 0,\n \"nomeProduto\": \"string\",\n \"sku\": \"string\",\n \"quantidade\": 0,\n \"receita\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nomeProduto": { + "type": "string", + "example": "string" + }, + "sku": { + "type": "string", + "example": "string" + }, + "quantidade": { + "type": "integer", + "example": 0, + "default": 0 + }, + "receita": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa3c01412c6f0066379e7d" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json b/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json new file mode 100644 index 000000000..54b9bd021 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja.openapi.json @@ -0,0 +1,160 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/dashboard/pedidos": { + "get": { + "summary": "Retorna uma listagem com os últimos dez pedidos da loja", + "description": "Últimos Pedidos", + "operationId": "retorna-uma-listagem-com-os-ultimos-dez-pedidos-da-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "[\n {\n \"pedidoId\": 0,\n \"situacaoPedidoId\": 0,\n \"situacaoNome\": \"string\",\n \"data\": \"2022-06-15T13:26:37.804Z\",\n \"dataFormatado\": \"string\",\n \"hora\": \"string\",\n \"valorTotal\": \"string\"\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "pedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoPedidoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "situacaoNome": { + "type": "string", + "example": "string" + }, + "data": { + "type": "string", + "example": "2022-06-15T13:26:37.804Z" + }, + "dataFormatado": { + "type": "string", + "example": "string" + }, + "hora": { + "type": "string", + "example": "string" + }, + "valorTotal": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62aa381d3b0ee700a1f930f6" +} \ No newline at end of file diff --git a/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json b/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json new file mode 100644 index 000000000..6733d2dc7 --- /dev/null +++ b/wake/utils/openapi/retorna-uma-tabela-de-precos.openapi.json @@ -0,0 +1,135 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tabelaPrecos/{tabelaPrecoId}": { + "get": { + "summary": "Retorna uma tabela de preços", + "description": "Tabela de preços específica", + "operationId": "retorna-uma-tabela-de-precos", + "parameters": [ + { + "name": "tabelaPrecoId", + "in": "path", + "description": "Id da tabela de preço", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "{\n \"tabelaPrecoId\": 0,\n \"nome\": \"string\",\n \"dataInicial\": \"2022-07-19T11:05:47.627Z\",\n \"dataFinal\": \"2022-07-19T11:05:47.627Z\",\n \"ativo\": true,\n \"isSite\": true\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "tabelaPrecoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dataInicial": { + "type": "string", + "example": "2022-07-19T11:05:47.627Z" + }, + "dataFinal": { + "type": "string", + "example": "2022-07-19T11:05:47.627Z" + }, + "ativo": { + "type": "boolean", + "example": true, + "default": true + }, + "isSite": { + "type": "boolean", + "example": true, + "default": true + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d6a8456f513300317abca1" +} \ No newline at end of file diff --git a/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json b/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json new file mode 100644 index 000000000..35301bd18 --- /dev/null +++ b/wake/utils/openapi/retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja.openapi.json @@ -0,0 +1,161 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/assinaturas/grupoassinatura": { + "get": { + "summary": "Retorna os dados de um grupo de assinatura de uma loja", + "description": "Grupo de assinatura", + "operationId": "retornando-os-dados-de-um-grupo-de-assinatura-de-uma-loja", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "[\n {\n \"grupoAssinaturaId\": 0,\n \"nome\": \"string\",\n \"recorrencias\": [\n {\n \"recorrenciaId\": 0,\n \"nome\": \"string\",\n \"dias\": 0\n }\n ]\n }\n]" + } + }, + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "grupoAssinaturaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "recorrencias": { + "type": "array", + "items": { + "type": "object", + "properties": { + "recorrenciaId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "nome": { + "type": "string", + "example": "string" + }, + "dias": { + "type": "integer", + "example": 0, + "default": 0 + } + } + } + } + } + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:63adc84efc75ef0061a4e4b0" +} \ No newline at end of file diff --git a/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json b/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json new file mode 100644 index 000000000..2180cd130 --- /dev/null +++ b/wake/utils/openapi/seta-identificador-como-variante-principal.openapi.json @@ -0,0 +1,126 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/principal": { + "put": { + "summary": "Seta identificador como variante principal", + "description": "Seta identificador como variante principal", + "operationId": "seta-identificador-como-variante-principal", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c49900ba2366007d5c7cf0" +} \ No newline at end of file diff --git a/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json b/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json new file mode 100644 index 000000000..3e3b11657 --- /dev/null +++ b/wake/utils/openapi/seta-o-pedido-como-integrado.openapi.json @@ -0,0 +1,147 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/pedidos/complete": { + "post": { + "summary": "Seta o pedido como integrado", + "description": "", + "operationId": "seta-o-pedido-como-integrado", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "object", + "description": "Pedido que se deseja inserir o \"complete\"", + "properties": { + "pedidoId": { + "type": "integer", + "description": "Id do pedido", + "format": "int32" + } + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bb38fe1be7fc00138e6340" +} \ No newline at end of file diff --git a/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json b/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json new file mode 100644 index 000000000..e8bc5f012 --- /dev/null +++ b/wake/utils/openapi/seta-status-ativoinativo-do-produto-variante.openapi.json @@ -0,0 +1,141 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/produtos/{identificador}/situacao": { + "put": { + "summary": "Seta status ativo/inativo do produto variante", + "description": "Seta status do produto variante como ativo ou inativo", + "operationId": "seta-status-ativoinativo-do-produto-variante", + "parameters": [ + { + "name": "identificador", + "in": "path", + "description": "Valor único utilizado para identificar o produto", + "schema": { + "type": "string" + }, + "required": true + }, + { + "name": "tipoIdentificador", + "in": "query", + "description": "Define se o identificador informado é um sku ou um id interno.", + "schema": { + "type": "string", + "enum": [ + "Sku", + "ProdutoVarianteId" + ] + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "status": { + "type": "boolean", + "description": "Define se o produto variante informado será ativo ou inativo" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62c499af3ccc21003edd7624" +} \ No newline at end of file diff --git a/wake/utils/openapi/templates.openapi.json b/wake/utils/openapi/templates.openapi.json new file mode 100644 index 000000000..7ace52fc3 --- /dev/null +++ b/wake/utils/openapi/templates.openapi.json @@ -0,0 +1,91 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/templates": { + "get": { + "summary": "Templates", + "description": "", + "operationId": "templates", + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "OK": { + "value": "OK" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62d070a2477c3d00691210b6" +} \ No newline at end of file diff --git a/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json b/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json new file mode 100644 index 000000000..ae94a5414 --- /dev/null +++ b/wake/utils/openapi/troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja.openapi.json @@ -0,0 +1,122 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/autenticacao/trocarLoja/{novaLoja}": { + "post": { + "summary": "Troca o usuário de loja e gera um novo access_token para acesso a nova loja", + "description": "Novo token gerado com sucesso", + "operationId": "troca-o-usuario-de-loja-e-gera-um-novo-access_token-para-acesso-a-nova-loja", + "parameters": [ + { + "name": "novaLoja", + "in": "path", + "description": "Loja para qual o usuário deseja autenticar.", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"lojas\": [\n \"string\"\n ],\n \"accessToken\": \"string\",\n \"dataExpiracaoAccessTokenUTC\": \"2022-06-09T11:21:37.424Z\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "lojas": { + "type": "array", + "items": { + "type": "string", + "example": "string" + } + }, + "accessToken": { + "type": "string", + "example": "string" + }, + "dataExpiracaoAccessTokenUTC": { + "type": "string", + "example": "2022-06-09T11:21:37.424Z" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a2492cf0f787009eb5b9b0" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json b/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json new file mode 100644 index 000000000..bbcd9d8ab --- /dev/null +++ b/wake/utils/openapi/vincula-hotsites-com-um-banner-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/hotsites": { + "post": { + "summary": "Vincula hotsites com um banner específico", + "description": "", + "operationId": "vincula-hotsites-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve vincular os hotsites", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "RAW_BODY": { + "type": "array", + "description": "lista de identificadores de hotsites a serem vinculados ao banner", + "items": { + "properties": { + "hotSiteId": { + "type": "integer", + "description": "Id do hotsite (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a749052436ab012aa552c9" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json b/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json new file mode 100644 index 000000000..1879ffe5d --- /dev/null +++ b/wake/utils/openapi/vincula-parceiros-com-um-banner-especifico.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/banners/{bannerId}/parceiros": { + "post": { + "summary": "Vincula parceiros com um banner específico", + "description": "", + "operationId": "vincula-parceiros-com-um-banner-especifico", + "parameters": [ + { + "name": "bannerId", + "in": "path", + "description": "Identificador do banner que deve vincular os parceiros", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos parceiros", + "items": { + "properties": { + "parceiroId": { + "type": "integer", + "description": "Id do parceiro (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a7753bb2fa3800809051e5" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json b/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json new file mode 100644 index 000000000..9aff71bd4 --- /dev/null +++ b/wake/utils/openapi/vincula-produtos-a-um-grupo-de-personalizacao.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/grupospersonalizacao/{grupoPersonalizacaoId}/produtos": { + "post": { + "summary": "Vincula produtos a um Grupo de Personalização", + "description": "", + "operationId": "vincula-produtos-a-um-grupo-de-personalizacao", + "parameters": [ + { + "name": "grupoPersonalizacaoId", + "in": "path", + "description": "Id do grupo de personalização", + "schema": { + "type": "integer", + "format": "int32" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de Id dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "201": { + "description": "201", + "content": { + "application/json": { + "examples": { + "Vinculo de produto com um Grupo de Personalização": { + "value": "Vínculo de produto com um Grupo de Personalização" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62b5eb60dcc89300505b65c2" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..038aceec9 --- /dev/null +++ b/wake/utils/openapi/vincula-um-ou-mais-banners-a-um-hotsite-especifico.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/banners": { + "post": { + "summary": "Vincula um ou mais banners a um hotsite específico", + "description": "", + "operationId": "vincula-um-ou-mais-banners-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser vinculado os banners", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "banners": { + "type": "array", + "description": "Lista de identificadores de banners para vincular ao hotsite", + "items": { + "properties": { + "bannerId": { + "type": "integer", + "description": "Identificador do banner (optional)", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a89dc7ae39270014280dd1" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json new file mode 100644 index 000000000..ac8067fd7 --- /dev/null +++ b/wake/utils/openapi/vincula-um-ou-mais-conteudos-a-um-hotsite-especifico.openapi.json @@ -0,0 +1,162 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/hotsites/{hotsiteId}/conteudos": { + "post": { + "summary": "Vincula um ou mais conteúdos a um hotsite específico", + "description": "", + "operationId": "vincula-um-ou-mais-conteudos-a-um-hotsite-especifico", + "parameters": [ + { + "name": "hotsiteId", + "in": "path", + "description": "Identificador do hotsite a ser vinculado os conteúdos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista de identificadores de conteúdos a serem vinculados", + "items": { + "properties": { + "conteudoId": { + "type": "integer", + "description": "Identificador do conteúdo", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62a8e60d0fc56200a8a966f2" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json new file mode 100644 index 000000000..7b97a81e5 --- /dev/null +++ b/wake/utils/openapi/vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente.openapi.json @@ -0,0 +1,159 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/eventos/{eventoId}/produtos": { + "post": { + "summary": "Vincula um ou mais produtos a um evento sem remover os produtos vinculados anteriormente", + "description": "", + "operationId": "vincula-um-ou-mais-produtos-a-um-evento-sem-remover-os-produtos-vinculados-anteriormente", + "parameters": [ + { + "name": "eventoId", + "in": "path", + "description": "Identificador do evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtosVariante": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "422": { + "description": "422", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ac8bbd70735c003bc9576a" +} \ No newline at end of file diff --git a/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json b/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json new file mode 100644 index 000000000..cc99163c0 --- /dev/null +++ b/wake/utils/openapi/vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento.openapi.json @@ -0,0 +1,177 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/tiposEvento/{tipoEventoId}/produtos": { + "post": { + "summary": "Vincula um ou mais produtos como sugestão para um tipo de evento", + "description": "Lista de resposta para cada produto vinculado", + "operationId": "vincula-um-ou-mais-produtos-como-sugestao-para-um-tipo-de-evento", + "parameters": [ + { + "name": "tipoEventoId", + "in": "path", + "description": "Identificador do tipo de evento", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "produtos": { + "type": "array", + "description": "Identificadores dos produtos variantes a serem vinculados ao tipo evento desejado", + "items": { + "properties": { + "produtoVarianteId": { + "type": "integer", + "description": "Identificador do produto variante", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "{\n \"sugestaoProdutosInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ],\n \"produtosNaoInseridos\": [\n {\n \"tipoEventoId\": 0,\n \"produtoVarianteId\": 0,\n \"detalhes\": \"string\"\n }\n ]\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "sugestaoProdutosInseridos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + }, + "produtosNaoInseridos": { + "type": "array", + "items": { + "type": "object", + "properties": { + "tipoEventoId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "produtoVarianteId": { + "type": "integer", + "example": 0, + "default": 0 + }, + "detalhes": { + "type": "string", + "example": "string" + } + } + } + } + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Result": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62ceb295f1e06a02cf6061e8" +} \ No newline at end of file diff --git a/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json b/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json new file mode 100644 index 000000000..ebc5ad505 --- /dev/null +++ b/wake/utils/openapi/vinculo-de-produtos-ao-portfolio.openapi.json @@ -0,0 +1,143 @@ +{ + "openapi": "3.1.0", + "info": { + "title": "API Pública", + "version": "1.0" + }, + "servers": [ + { + "url": "https://api.fbits.net/" + } + ], + "components": { + "securitySchemes": { + "sec0": { + "type": "apiKey", + "in": "header", + "x-default": "", + "name": "Authorization", + "x-bearer-format": "basic" + } + } + }, + "security": [ + { + "sec0": [] + } + ], + "paths": { + "/portfolios/{portfolioId}/produtos": { + "put": { + "summary": "Vinculo de produtos ao portfolio", + "description": "", + "operationId": "vinculo-de-produtos-ao-portfolio", + "parameters": [ + { + "name": "portfolioId", + "in": "path", + "description": "Id do portfolio que se deseja atualizar os produtos", + "schema": { + "type": "integer", + "format": "int64" + }, + "required": true + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "RAW_BODY" + ], + "properties": { + "RAW_BODY": { + "type": "array", + "description": "Lista dos Id's dos produtos", + "items": { + "properties": { + "produtoId": { + "type": "integer", + "description": "Id do produto", + "format": "int32" + } + }, + "type": "object" + } + } + } + } + } + } + }, + "responses": { + "200": { + "description": "200", + "content": { + "application/json": { + "examples": { + "True": { + "value": "True" + } + } + } + } + }, + "404": { + "description": "404", + "content": { + "application/json": { + "examples": { + "Produto não encontrado": { + "value": "Produto não encontrado" + } + } + } + } + }, + "500": { + "description": "500", + "content": { + "application/json": { + "examples": { + "Erro no processamento da operação": { + "value": "{\n \"resultadoOperacao\": true,\n \"codigo\": 0,\n \"mensagem\": \"string\"\n}" + } + }, + "schema": { + "type": "object", + "properties": { + "resultadoOperacao": { + "type": "boolean", + "example": true, + "default": true + }, + "codigo": { + "type": "integer", + "example": 0, + "default": 0 + }, + "mensagem": { + "type": "string", + "example": "string" + } + } + } + } + } + } + }, + "deprecated": false + } + } + }, + "x-readme": { + "headers": [], + "explorer-enabled": true, + "proxy-enabled": true, + "samples-enabled": true + }, + "x-readme-fauxas": true, + "_id": "629f940ff6822d00a2406e17:62bef37c5e40970014a6239c" +} \ No newline at end of file diff --git a/wake/utils/transform.ts b/wake/utils/transform.ts new file mode 100644 index 000000000..3c3b6eac3 --- /dev/null +++ b/wake/utils/transform.ts @@ -0,0 +1,219 @@ +import { + BreadcrumbList, + ListItem, + Product, + ProductListingPage, + PropertyValue, + UnitPriceSpecification, +} from "../../commerce/types.ts"; +import { DEFAULT_IMAGE } from "../../commerce/utils/constants.ts"; +import { + ProductFragment, + SearchQuery, + SingleProductFragment, +} from "./graphql/graphql.gen.ts"; + +export const stale = { + deco: { cache: "stale-while-revalidate" }, +}; + +export const FILTER_PARAM = "filtro"; + +export const camposAdicionais = [ + "Atacado", + "Estoque", + "Atributo", + "Informacao", + "TabelaPreco", +]; + +export const parseSlug = (slug: string) => { + const segments = slug.split("-"); + const id = Number(segments.at(-1)); + + if (!id) { + throw new Error("Malformed slug. Expecting {slug}-{id} format"); + } + + return { + slug: segments.slice(0, -1).join("-"), + id: Number(segments.at(-1)), + }; +}; + +export const getProductUrl = ( + { alias }: ProductFragment | SingleProductFragment, + base: URL | string, +) => new URL(`/produto/${alias}`, base); + +export const getVariantUrl = ( + variant: ProductFragment | SingleProductFragment, + base: URL | string, +) => { + const url = getProductUrl(variant, base); + + url.searchParams.set("skuId", variant.productVariantId); + + return url; +}; + +export const toFilters = ( + aggregations: NonNullable["aggregations"], + { base }: { base: URL }, +): ProductListingPage["filters"] => + aggregations?.filters?.map((filter) => ({ + "@type": "FilterToggle", + key: filter?.origin ?? "", + label: filter?.field ?? "", + quantity: 0, + values: filter?.values?.map((filterValue) => { + const url = new URL(base); + const { name, quantity } = filterValue!; + const index = url.searchParams + .getAll(FILTER_PARAM) + .findIndex((f) => f === name); + const selected = index > -1; + + if (selected) { + const params = new URLSearchParams(); + url.searchParams.forEach((value, key) => { + if (key !== FILTER_PARAM || !value.endsWith(name!)) { + params.append(key, value); + } + }); + url.search = `${params}`; + } else { + url.searchParams.append(FILTER_PARAM, `${filter.field}:${name}`); + } + + return { + value: name!, + label: name!, + quantity: quantity!, + selected, + url: url.href, + }; + }) ?? [], + })) ?? []; + +export const toBreadcrumbList = ( + product: Product, + categories: ProductFragment["productCategories"], + { base }: { base: URL }, +): BreadcrumbList => { + const category = categories?.find((c) => c?.main); + const segments = category?.url?.split("/") ?? []; + const names = category?.hierarchy?.split(" > ") ?? []; + const itemListElement = segments.length === names.length + ? [ + ...segments.map((_, i): ListItem => ({ + "@type": "ListItem", + name: names[i], + position: i + 1, + item: new URL(`/${segments.slice(0, i + 1).join("/")}`, base).href, + })), + { + "@type": "ListItem", + name: product.isVariantOf?.name, + url: product.isVariantOf?.url, + position: segments.length + 1, + } as ListItem, + ] + : []; + + return { + "@type": "BreadcrumbList", + numberOfItems: itemListElement.length, + itemListElement, + }; +}; + +export const toProduct = ( + variant: ProductFragment | SingleProductFragment, + { base }: { base: URL | string }, +): Product => { + const images = variant.images?.map((image) => ({ + "@type": "ImageObject" as const, + url: image?.url ?? "", + alternateName: image?.fileName ?? "", + })); + const additionalProperty: PropertyValue[] = []; + variant.informations?.forEach((info) => + additionalProperty.push({ + "@type": "PropertyValue", + name: info?.title ?? undefined, + value: info?.value ?? undefined, + valueReference: "INFORMATION", + }) + ); + variant.attributes?.forEach((attr) => + additionalProperty.push({ + "@type": "PropertyValue", + name: attr?.name ?? undefined, + value: attr?.value ?? undefined, + valueReference: "SPECIFICATION", + }) + ); + + const priceSpecification: UnitPriceSpecification[] = []; + if (variant.prices?.listPrice) { + priceSpecification.push({ + "@type": "UnitPriceSpecification", + priceType: "https://schema.org/ListPrice", + price: variant.prices.listPrice, + }); + } + if (variant.prices?.price) { + priceSpecification.push({ + "@type": "UnitPriceSpecification", + priceType: "https://schema.org/SalePrice", + price: variant.prices.price, + }); + } + + return { + "@type": "Product", + url: getVariantUrl(variant, base).href, + gtin: variant.ean ?? undefined, + sku: variant.sku!, + description: + variant.informations?.find((info) => info?.type === "Descrição")?.value ?? + undefined, + productID: variant.productVariantId, + name: variant.variantName ?? undefined, + inProductGroupWithID: variant.productId, + image: !images?.length ? [DEFAULT_IMAGE] : images, + brand: { + "@type": "Brand", + name: variant.productBrand?.name ?? "", + url: variant.productBrand?.logoUrl ?? variant.productBrand?.fullUrlLogo ?? + "", + }, + isSimilarTo: [], + isVariantOf: { + "@type": "ProductGroup", + url: getProductUrl(variant, base).href, + name: variant.productName ?? undefined, + productGroupID: variant.productId, + hasVariant: [], + additionalProperty: [], + }, + additionalProperty, + offers: { + "@type": "AggregateOffer", + highPrice: variant.prices?.price, + lowPrice: variant.prices?.price, + offerCount: 1, + offers: [{ + "@type": "Offer", + seller: variant.seller?.name ?? undefined, + price: variant.prices?.price, + priceSpecification, + availability: variant.available + ? "https://schema.org/InStock" + : "https://schema.org/OutOfStock", + inventoryLevel: { value: variant.stock }, + }], + }, + }; +};