diff --git a/spectaql/config_saas.yml b/spectaql/config_saas.yml index 4617f2cf5..47291976d 100644 --- a/spectaql/config_saas.yml +++ b/spectaql/config_saas.yml @@ -1,60 +1,360 @@ --- spectaql: + # Optional Boolean indicating whether to omit the HTML and generate the documentation content only + # Default: false embeddable: true + + # Optional Boolean indicating whether to embed all resources (CSS and JS) into the same file + # Default: false oneFile: false + + # Optional path to the target build directory. + # Set to null to not write the output to the filesystem, making it only available via the API (default: public) + # + # Default: public targetDir: src/pages/includes/autogenerated targetFile: graphql-api-saas.md + + # Optional boolean indicating whether to encode the local logoFile and embed the image as Base64 + # into the resulting HTML. Only applicable if providing the logoFile. + # + # Default: false embedLogo: false + + # Optional string specifying a path to a theme directory to use for your build. + # + # Themes rely on a directory structure convention that overlays your customizations and enhancements + # on top of the default theme provided by SpectaQL. See /examples/themes for more. + # + # Also, a few built-in themes can be used by specifying them by name: + # "default": Our default theme + # "basic": Outputs the same HTML structure as the "default" theme, but with minimal CSS styling + # "spectaql": Outputs the same HTML structure as the "default" theme, but with some CSS enhancements + # + # Default: "default" themeDir: spectaql/markdown-theme gruntConfigFile: spectaql/markdown-grunt-config.js + + # If you're embedding SpectaQL's output, and you've got something like a Nav Bar that + # gets in the way, you can use this value to adjust the scroll offset + # + # Default: None; No "scroll-padding-top" style will be applied. scrollPaddingTopPx: 0 + + # If an interpolated reference is not found, should SpectaQL throw an error? Otherwise, a warning + # will be logged. + # + # Default: true errorOnInterpolationReferenceNotFound: true + + # Would you like to display all the servers listed in the servers area of your config? Otherwise, + # it will try to display just the one marked "production: true". + # + # Default: false displayAllServers: false + + # Would you like the "run" function to resolve with an object containing the output as a string? + # Useful if you are using SpectaQL as a dependency (as opposed to running the binary executable) + # + # Default: true resolveWithOutput: true introspection: + ############################################## + # These options specify where/how to get the information required to generate your + # documentation. + # + # Each of these have corresponding CLI options where they can be expressed instead of here. + # The CLI options will take precedence over what is in your config file + # + # 1 and only 1 of the following options must be provided: + # + + # File containing a GraphQL Schema Definition written in SDL. + # Can also pass an array of paths (or glob supported by @graphql-tools/load-files) + # like so: + # schemaFile: + # - path/to/schema/part1.gql + # - path/to/schema/part2.gql + # schemaFile: path/to/schema.gql + + # File containing Introspection Query response in JS module export, or JSON format introspectionFile: spectaql/schema_saas.json + + # URL of the GraphQL endpoint to hit if you want to generate the documentation based on live + # Introspection Query results + # NOTE: If not using introspection.url OR servers[], you need to provide x-url below + # url: https://yoursite.com/graphql + + # + # + ############################################## + + # If using the "url" option above, any headers (such as Authorization) can be added here. This + # can also be added via the CLI options + # headers: + # Authorization: Bearer s3cretT0k2n + + # Some helpful options for those who are an "SDL-first" shop and/or want to get your metadata into + # SpectaQL during the SDL ingestion. spectaqlDirective: + # Boolean indicating whether to enable and process the @spectaql directive + # + # Default: true enable: false + + # String indicating the name to use for the SpectaQL directive, e.g. "@spectaql" + # This should be inconsequential in the end since it should be removed + # from your resulting Schema by SpectaQL + # + # Default: 'spectaql' + # directiveName: 'spectaql' + + # String indicating the name to use for the Type used in the "options" array that can be passed + # to the SpectaQL directive. + # This should be inconsequential in the end since it should be removed + # from your resulting Schema by SpectaQL + # + # Default: 'SpectaQLOption' + # optionsTypeName: 'SpectaQLOption' + + # + # + ############################################## + + ############################################## + # These options are for random display or augmentation related things that didn't + # really fit anywhere else. + # + + # Whether you would like to strip any trailing commas from the descriptions to keep + # things fresh and clean. + # + # Default: false removeTrailingPeriodFromDescriptions: false + + # What manipulation of the query/mutation/subscription name would you like to perform to determine + # the name in query examples? Possible values: + # + # - none: will use same exact name as query) + # - capitalizeFirst: will capitalize the first letter and leave the rest. + # - capitalize: will capitalize the first letter and convert the rest to lower case. + # - camelCase + # - snakeCase + # - upperCase: all letters to upper case. + # - lowerCase: all letters to lower case. queryNameStrategy: none + + # When generating a Query or Mutation example, to what maximum depth should any nested fields + # be represented before a fragment placeholder is rendered? + # + # Default: 1 fieldExpansionDepth: 1 + + # Include support for @deprecated field on InputType fields. + # NOTE: Be careful, it appears that if you mark an InputType field as deprecated but do NOT set + # this option to `true`, the field will be removed from the schema completely. + # + # Default: false inputValueDeprecation: true + + # + # + ############################################## + + ############################################## + # These options specify how, where and if any "metadata" information is to be added to your Introspection + # Query results IF it is not already present. If you are not dealing with metadata, or you have already + # baked it into your Introspection Query results somehow (on the server-side, for example) then you + # can ignore these options completely. + # + + # File that contains your metadata data in JS module export, or JSON format + # Items marked with `documentation: { undocumented: true }` will be hidden + # from the rendered output (combined with hide*WithUndocumentedReturnType and + # hideUnusedTypes options below). + metadataFile: spectaql/metadata-saas.json + + # The path to a key from which to read the documentation-related metadata at each level of your metadata file. + # Defaults to 'documentation', but in case you use a different name, or have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + metadatasReadPath: documentation + + # The metadata that was just read from the above key path will be woven into your Introspection Query results. + # This option specifies the key path where that data will be written at each level. + # + # *** + # In order to ensure that the metadata you've written can be found later on down the line, this value + # should be set the same as the "metadatasPath" option below + # *** + # + # Defaults to 'documentation', but in case you have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + metadatasWritePath: documentation + + # + # + ############################################## + + ############################################## + # These options specify how, where and if any "metadata" information is to be found, or + # used/ignored when processing your documentation. + # + + # The key path in your Introspection Query results where metadata supported by this library can + # be found. + # Defaults to 'documentation', but in case you have a complex/nested metadata structure, you can + # specify it here. + # + # Default: documentation + metadatasPath: documentation + + # Whether or not to look for and use metadata in your data. If turned off, metadata will be ignored + # even if it's there + # + # Default: true + metadatas: true + + # + # + ############################################## + + + # This allows you to specify a custom path to a JS module to handle the generation of + # example values for your schema. + # Default: none + # dynamicExamplesProcessingModule: path/to/examples.js + + ############################################## + # These options specify what the default behavior should be + # (regarding documented vs non-documented) in the absence of + # metadata directives on a given item + + # Whether to document any Queries at all, in the absence of a metadata directive + # Default: true queriesDocumentedDefault: true + # Whether to document an individual Query, in the absence of a metadata directive + # Default: true queryDocumentedDefault: true + # Whether to document a Query Argument, in the absence of a metadata directive + # Default: true queryArgDocumentedDefault: true + # Hide any Queries with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true hideQueriesWithUndocumentedReturnType: true + + # Whether to document any Mutations at all, in the absence of a metadata directive + # Default: true mutationsDocumentedDefault: true + # Whether to document an individual Mutation, in the absence of a metadata directive + # Default: true mutationDocumentedDefault: true + # Whether to document a Mutation Argument, in the absence of a metadata directive + # Default: true mutationArgDocumentedDefault: true + # Hide any Mutations with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true hideMutationsWithUndocumentedReturnType: true + + # Whether to document any Subscriptions at all + # Default: true subscriptionsDocumentedDefault: true + # Whether to document an individual Subscription, in the absence of a metadata directive + # Default: true subscriptionDocumentedDefault: true + # Whether to document a Subscription Argument, in the absence of a metadata directive + # Default: true subscriptionArgDocumentedDefault: true + # Hide any Subscriptions with undocumented return types so as not to reference something + # that seemingly does not exist. + # Default: true hideSubscriptionsWithUndocumentedReturnType: true + + # Hide any Types that are not used anywhere in your schema after other things have been hidden. + # Default: true hideUnusedTypes: true + + # Whether to document any Types at all + # Default: true objectsDocumentedDefault: true + # Whether to document an individual Type, in the absence of a metadata directive + # Default: true objectDocumentedDefault: true + + # Whether to document any Input Object types at all + # Default: true inputsDocumentedDefault: true + # Whether to document an individual Input Object, in the absence of a metadata directive + # Default: true inputDocumentedDefault: true + + # Whether to document any Enums at all + # Default: true enumsDocumentedDefault: true + # Whether to document an individual Enum, in the absence of a metadata directive + # Default: true enumDocumentedDefault: true + + # Whether to document any Unions at all + # Default: true unionsDocumentedDefault: true + # Whether to document an individual Union, in the absence of a metadata directive + # Default: true unionDocumentedDefault: true + # Hide Union possibleTypes that are not documented so as not to reference something + # that seemingly does not exist. + # Default: true hideUnionTypesOfUndocumentedType: true + + # Whether to document an individual Field, in the absence of a metadata directive + # Default: true fieldDocumentedDefault: true + # Hide any fields of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true hideFieldsOfUndocumentedType: true + + # Whether to document an individual Input Field, in the absence of a metadata directive + # Default: true inputFieldDocumentedDefault: true + # Hide any inputFields of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true hideInputFieldsOfUndocumentedType: true + + # Whether to document an individual Argument, in the absence of a metadata directive + # Default: true argDocumentedDefault: true + # Hide any args of undocumented types so as not to reference something + # that seemingly does not exist. + # Default: true hideArgsOfUndocumentedType: true + # + # + ############################################## + extensions: + # Utilize the 'graphql-scalars' library when generating examples for scalars it supports that + # do not have an example already set via some other method. Usually this is a good + # thing to have on, but it is possible to turn it off. + # Default: true graphqlScalarExamples: true servers: + # NOTE: If not using introspection.url OR servers[], you need to provide x-url + + # same format as for OpenAPI Specification https://swagger.io/specification/#server-object + - url: https://.api.commerce.adobe.com//graphql description: Production Server + # A place to list any Headers for your GraphQL API calls headers: - name: Authorization example: Bearer @@ -63,12 +363,37 @@ servers: [GraphQL headers](https://developer.adobe.com/commerce/webapi/graphql/usage/headers). info: + # Tries to adhere to OpenAPI Specification https://swagger.io/specification/#info-object + # Will be used to populate the Welcome section of the output + + ############################################## + # Introduction area flags + # + + # Set to true to do no Introduction area rendering at all. Supersedes the below options + # Default: false x-hideIntroduction: false + # Set to true to not render a friendly Welcome section based on the description in this area + # Default: false x-hideWelcome: false + # Set to true to not render your intro items + # Default: false x-hideIntroItems: true + + # Set to true to not render the deprecated label + # Default: false x-hideIsDeprecated: false + # Set to true to not render the deprecation reason + # Default: false x-hideDeprecationReason: false + + # If you really want to hide the "Documentation by" at the bottom of your output, you can do so here + # Default: false x-hidePoweredBy: true + + # + ############################################## + description: >- The Adobe Commerce as a Cloud Service GraphQL API allows you to quickly and efficiently transfer information between your Commerce store and your diff --git a/spectaql/metadata-saas.json b/spectaql/metadata-saas.json new file mode 100644 index 000000000..4df42f171 --- /dev/null +++ b/spectaql/metadata-saas.json @@ -0,0 +1,76 @@ +{ + "OBJECT": { + "Query": { + "fields": { + "categoryTree": { + "documentation": { "undocumented": true } + }, + "navigation": { + "documentation": { "undocumented": true } + }, + "searchCategory": { + "documentation": { "undocumented": true } + }, + "recommendationsByUnitIds": { + "documentation": { "undocumented": true } + }, + "payByLinkOrder": { + "documentation": { "undocumented": true } + } + } + }, + "Mutation": { + "fields": { + "completePayByLinkPayment": { + "documentation": { "undocumented": true } + } + } + }, + "CategoryTreeView": { + "documentation": { "undocumented": true } + }, + "CategoryNavigationView": { + "documentation": { "undocumented": true } + }, + "CategoryProductView": { + "documentation": { "undocumented": true } + }, + "SearchCategoryResultPage": { + "documentation": { "undocumented": true } + }, + "CategoryMetaTags": { + "documentation": { "undocumented": true } + }, + "CategoryImage": { + "documentation": { "undocumented": true } + }, + "PageInfo": { + "documentation": { "undocumented": true } + }, + "PayByLinkOrder": { + "documentation": { "undocumented": true } + }, + "PayByLinkOrderAddress": { + "documentation": { "undocumented": true } + }, + "PayByLinkOrderItem": { + "documentation": { "undocumented": true } + }, + "PayByLinkOrderTotals": { + "documentation": { "undocumented": true } + }, + "CompletePayByLinkPaymentOutput": { + "documentation": { "undocumented": true } + } + }, + "INPUT_OBJECT": { + "PayByLinkInput": { + "documentation": { "undocumented": true } + } + }, + "INTERFACE": { + "CategoryViewV2": { + "documentation": { "undocumented": true } + } + } +} diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index 20860cb5e..c529c13e2 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -1922,6 +1922,124 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "AdminAssistanceAction", + "description": "A single admin assistance action performed on behalf of the customer.", + "fields": [ + { + "name": "action", + "description": "Action identifier, e.g. add_to_cart, place_order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "date", + "description": "When the action occurred.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "details", + "description": "Action related details, e.g. product SKUs, order id.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AdminAssistanceActions", + "description": "Paginated admin assistance actions for the customer.", + "fields": [ + { + "name": "items", + "description": "Admin assistance actions for the current page.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AdminAssistanceAction", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "page_info", + "description": "Contains pagination metadata.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "SearchResultPageInfo", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_count", + "description": "The total count of admin assistance actions for the customer.", + "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": "Aggregation", @@ -3030,6 +3148,72 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "AssignChildCompanyInput", + "description": "Defines the input schema for assigning a child company to a parent company.", + "fields": null, + "inputFields": [ + { + "name": "child_company_id", + "description": "The unique ID of the child company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "parent_company_id", + "description": "The unique ID of the parent company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "AssignChildCompanyOutput", + "description": "Contains the response to the request to assign a child company.", + "fields": [ + { + "name": "company_hierarchy", + "description": "The updated company hierarchy for the parent company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyHierarchy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "AssignCompareListToCustomerOutput", @@ -5323,6 +5507,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "bundle_options", "description": "An array containing the bundle options the shopper selected.", @@ -5448,6 +5644,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -5477,7 +5689,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -9271,6 +9483,18 @@ "name": "CartItemInterface", "description": "An interface for products in a cart.", "fields": [ + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "custom_attributes", "description": "The custom attributes for the cart item", @@ -9332,6 +9556,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -9361,7 +9601,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -11824,6 +12064,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "position", + "description": "The position of the category in sort order. For example, `1`, `2`, `3` or `10`.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "path", "description": "Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`.", @@ -13536,6 +13788,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "is_admin", + "description": "Indicates whether the company is the admin (parent) company in the returned relation hierarchy.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "legal_name", "description": "The full legal name of the company.", @@ -14062,6 +14330,49 @@ ], "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CompanyHierarchy", + "description": "Defines a parent company and its direct child companies.", + "fields": [ + { + "name": "children", + "description": "An array of direct child companies.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "parent", + "description": "The parent company in the relation hierarchy. Null if the company has no parent.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CompanyBasicInfo", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "CompanyInvitationInput", @@ -15659,6 +15970,33 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CompletePayByLinkPaymentOutput", + "description": "Result of completing a Pay By Link payment.", + "fields": [ + { + "name": "order_number", + "description": "The increment id of the order whose payment was completed.", + "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": "ComplexProductView", @@ -16242,6 +16580,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "configurable_options", "description": "An array containing the configuranle options the shopper selected.", @@ -16383,6 +16733,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -16412,7 +16778,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -22783,6 +23149,37 @@ ], "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CurrentProductInput", + "description": "Attributes of the product currently being viewed on PDP", + "fields": null, + "inputFields": [ + { + "name": "sku", + "description": "SKU of the current product", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "price", + "description": "Resolved display price of the current product (specialPrice ?? regularPrice)", + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "CustomAttribute", @@ -23175,6 +23572,43 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "admin_assistance_actions", + "description": "Actions performed by an admin on behalf of the customer (Login as Customer logging).", + "args": [ + { + "name": "currentPage", + "description": "Specifies which page of results to return. The default value is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + }, + { + "name": "pageSize", + "description": "Specifies the maximum number of results to return at once. The default value is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "AdminAssistanceActions", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "allow_remote_shopping_assistance", "description": "Indicates whether the customer has enabled remote shopping assistance.", @@ -23218,6 +23652,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "company_hierarchy", + "description": "The company relation hierarchies for all companies. Only available to the company administrator.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyHierarchy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "compare_list", "description": "The contents of the customer's compare list.", @@ -25357,6 +25807,18 @@ "name": "CustomerOrder", "description": "Contains details about each of the customer's orders.", "fields": [ + { + "name": "admin_assisted_order", + "description": "Admin user id when the order was placed with assistance (Login as Customer); null if not assisted.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "applied_coupons", "description": "Coupons applied to the order.", @@ -28942,6 +29404,18 @@ "name": "DownloadableCartItem", "description": "An implementation for downloadable product cart items.", "fields": [ + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "custom_attributes", "description": "The custom attributes for the cart item", @@ -29023,6 +29497,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -29068,7 +29558,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -32593,6 +33083,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "custom_attributes", "description": "The custom attributes for the cart item", @@ -32698,6 +33200,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -32739,7 +33257,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -38167,6 +38685,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "ImportSharedRequisitionListOutput", + "description": "Result of importing a shared requisition list.", + "fields": [ + { + "name": "requisition_list", + "description": "The imported requisition list for the current customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Validation or import issues.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShareRequisitionListUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "initiateUploadInput", @@ -40899,6 +41460,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "assignChildCompany", + "description": "Assign a child company to a parent company within the company relation hierarchy.", + "args": [ + { + "name": "input", + "description": "An input object that defines which companies to relate.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AssignChildCompanyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AssignChildCompanyOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "assignCompareListToCustomer", "description": "Assign the specified compare list to the logged in customer.", @@ -41183,6 +41771,47 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "completePayByLinkPayment", + "description": "Complete a Pay By Link payment for an in-process gateway (Payment Services).", + "args": [ + { + "name": "token", + "description": "The token issued for the Pay By Link payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "payment_method", + "description": "The payment method the customer has selected to complete the order.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "PaymentMethodInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "CompletePayByLinkPaymentOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "confirmCancelOrder", "description": "Cancel the specified guest customer order.", @@ -42297,7 +42926,7 @@ }, { "name": "exchangeOtpForCustomerToken", - "description": "Exchange a customer's one time password for a customer token.", + "description": "Exchange one time login code for customer token.", "args": [ { "name": "email", @@ -42458,6 +43087,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "importSharedRequisitionList", + "description": "Import a shared requisition list into the current customer account.", + "args": [ + { + "name": "token", + "description": "The token for the shared requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ImportSharedRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "initiateUpload", "description": null, @@ -44313,6 +44969,60 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "shareRequisitionListByEmail", + "description": "Share a requisition list with company colleagues via email using a secure link.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "ShareRequisitionListByEmailInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShareRequisitionListByEmailOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shareRequisitionListByToken", + "description": "Share a requisition list by issuing a token for colleagues in the same company. Use the token to build a shareable link on the storefront.", + "args": [ + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "ShareRequisitionListByTokenOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "submitNegotiableQuoteTemplateForReview", "description": "Accept an existing negotiable quote template.", @@ -44444,6 +45154,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "unassignChildCompany", + "description": "Unassign a child company from its parent company within the company relation hierarchy.", + "args": [ + { + "name": "input", + "description": "An input object that defines which company to unassign.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "UnassignChildCompanyInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "UnassignChildCompanyOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "unsubscribeProductAlertPrice", "description": "Unsubscribe logged-in customer to price alert for a product.", @@ -51349,6 +52086,423 @@ ], "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "PayByLinkInput", + "description": "Defines optional inputs for the Pay By Link payment method.", + "fields": null, + "inputFields": [ + { + "name": "recipient_email", + "description": "Email address of the person who should receive the payment link. When omitted, the link is sent to the order customer's email.", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayByLinkOrder", + "description": "Read-only projection of the pending order behind a Pay By Link token. Returned by `payByLinkOrder` so the EDS payment page can render the order summary before collecting payment.", + "fields": [ + { + "name": "billing_address", + "description": "The order's billing address. Read-only on the payment page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PayByLinkOrderAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "customer_email", + "description": "Email address the payment link was sent to.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "expires_at", + "description": "UTC `Y-m-d H:i:s` timestamp after which the token is no longer redeemable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "items", + "description": "Top-level line items on the order. Resolve product detail (image, description, variant) from the Catalog Service using `sku`.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PayByLinkOrderItem", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping_address", + "description": "The order's shipping address. Read-only on the payment page.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "PayByLinkOrderAddress", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "totals", + "description": "Money totals for the order.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PayByLinkOrderTotals", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayByLinkOrderAddress", + "description": "Read-only address attached to a Pay By Link order.", + "fields": [ + { + "name": "city", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "country_code", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "firstname", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "lastname", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "postcode", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "region_code", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "street", + "description": null, + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "telephone", + "description": null, + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "PayByLinkOrderItem", + "description": "A single line item on a Pay By Link order.", + "fields": [ + { + "name": "name", + "description": "Product name captured on the order at placement time.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "price", + "description": "Unit price for the item, including currency.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "quantity", + "description": "Quantity ordered.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "SKU captured on the order line. Use this to resolve product detail from the Catalog Service.", + "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": "PayByLinkOrderTotals", + "description": "Order-level money totals.", + "fields": [ + { + "name": "grand_total", + "description": "Amount the customer will be charged.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shipping", + "description": "Shipping amount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "Sum of line item prices before shipping/tax/discount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "tax", + "description": "Tax amount.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "PaymentAttributeInput", @@ -51745,6 +52899,16 @@ }, "defaultValue": null }, + { + "name": "paybylink", + "description": "Pay By Link payment method options.", + "type": { + "kind": "INPUT_OBJECT", + "name": "PayByLinkInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "payment_services_paypal_apple_pay", "description": "Required input for Apple Pay button", @@ -59421,7 +60585,7 @@ }, { "name": "searchCategory", - "description": "Search for categories by name with optional filtering and pagination.", + "description": "Search for categories by name with optional filtering and pagination. Results are returned in alphabetical order by category name.", "args": [ { "name": "searchTerm", @@ -60567,6 +61731,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "payByLinkOrder", + "description": "Resolves a Pay By Link token to the pending order's summary so the EDS payment page can render it before collecting payment.", + "args": [ + { + "name": "token", + "description": "The token issued for the Pay By Link payment.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PayByLinkOrder", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "pickupLocations", "description": "The pickup locations query searches for locations that match the search request requirements.", @@ -60722,6 +61913,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sharedRequisitionList", + "description": "View a shared requisition list when the receiver is logged in and belongs to the same company as the sender.", + "args": [ + { + "name": "token", + "description": "The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SharedRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "storeConfig", "description": "Return details about the store's configuration.", @@ -60772,6 +61990,16 @@ }, "defaultValue": null }, + { + "name": "currentProduct", + "description": "Current product context from PDP (SKU, price, category, etc.)", + "type": { + "kind": "INPUT_OBJECT", + "name": "CurrentProductInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "pageType", "description": "Type of page on which recommendations are requested", @@ -60865,6 +62093,16 @@ }, "defaultValue": null }, + { + "name": "currentProduct", + "description": "Current product context from PDP (SKU, price, category, etc.)", + "type": { + "kind": "INPUT_OBJECT", + "name": "CurrentProductInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "userPurchaseHistory", "description": "User purchase history with timestamp", @@ -62043,6 +63281,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "userError", + "description": "User error message if the unit could not be fully resolved (e.g. required currentSku was not provided)", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -67390,6 +68640,49 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "SharedRequisitionListOutput", + "description": "Shared requisition list view for a recipient.", + "fields": [ + { + "name": "requisition_list", + "description": "The sender's requisition list (read-only for the recipient).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "RequisitionList", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sender_name", + "description": "Display name of the requisition list sender.", + "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": "ShareGiftRegistryInviteeInput", @@ -67495,6 +68788,201 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "ShareRequisitionListByEmailInput", + "description": "An input object that defines which requisition list shared with company users through email.", + "fields": null, + "inputFields": [ + { + "name": "customerUids", + "description": "An array of IDs representing company users with whom the sender wants to share the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "requisitionListUid", + "description": "The unique ID of the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShareRequisitionListByEmailOutput", + "description": "Result of sharing a requisition list by email.", + "fields": [ + { + "name": "sent_count", + "description": "Number of notification emails successfully sent.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Per-email validation or delivery issues.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "ShareRequisitionListUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "ShareRequisitionListByTokenOutput", + "description": "The result of sharing a requisition list by token.", + "fields": [ + { + "name": "token", + "description": "Token used to generate a shareable link for the requisition list.", + "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": "ShareRequisitionListUserError", + "description": "An error related to a specific recipient or constraint.", + "fields": [ + { + "name": "code", + "description": "Machine-readable error code.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "ShareRequisitionListUserErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "Human-readable 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": null + }, + { + "kind": "ENUM", + "name": "ShareRequisitionListUserErrorCode", + "description": "Machine-readable error codes for requisition list share-by-email and import operations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "MAX_RECIPIENTS_EXCEEDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_EMAIL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "NOT_COMPANY_USER", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "IMPORT_FAILED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "ENUM", "name": "ShipBundleItemsEnum", @@ -67786,6 +69274,18 @@ }, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "tracking_url", + "description": "The tracking URL for the shipment. Available for both built-in and custom shipping carriers when a URL template is configured.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null } ], "inputFields": null, @@ -68416,6 +69916,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "custom_attributes", "description": "The custom attributes for the cart item", @@ -68521,6 +70033,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -68550,7 +70078,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", @@ -71852,6 +73380,70 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "requisition_list_share_link_validity_days", + "description": "Configuration data from btob/requisition_list_sharing/link_validity_days", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requisition_list_share_max_recipients", + "description": "Configuration data from btob/requisition_list_sharing/max_recipients", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requisition_list_share_storefront_path", + "description": "Configuration data from btob/requisition_list_sharing/storefront_share_path (route path for share links, no leading or trailing slashes)", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requisition_list_sharing_enabled", + "description": "Configuration data from btob/requisition_list_sharing/enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "returns_enabled", "description": "Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled.", @@ -71996,6 +73588,46 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "shopping_assistance_checkbox_title", + "description": "Configuration data from login_as_customer/general/shopping_assistance_checkbox_title", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_assistance_checkbox_tooltip", + "description": "Configuration data from login_as_customer/general/shopping_assistance_checkbox_tooltip", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "shopping_assistance_enabled", + "description": "Configuration data from login_as_customer/general/enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shopping_cart_display_full_summary", "description": "Extended Config Data - tax/cart_display/full_summary", @@ -73073,6 +74705,58 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "UnassignChildCompanyInput", + "description": "Defines the input schema for unassigning a child company from its parent company.", + "fields": null, + "inputFields": [ + { + "name": "child_company_id", + "description": "The unique ID of the child company.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "UnassignChildCompanyOutput", + "description": "Contains the response to the request to unassign a child company.", + "fields": [ + { + "name": "company_hierarchy", + "description": "The updated company relation hierarchy for the current company.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "CompanyHierarchy", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "UnitConfigInput", @@ -74740,6 +76424,18 @@ "name": "VirtualCartItem", "description": "An implementation for virtual product cart items.", "fields": [ + { + "name": "backorder_message", + "description": "Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "custom_attributes", "description": "The custom attributes for the cart item", @@ -74821,6 +76517,22 @@ "ofType": null } }, + "isDeprecated": true, + "deprecationReason": "Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration." + }, + { + "name": "is_salable", + "description": "True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, "isDeprecated": false, "deprecationReason": null }, @@ -74850,7 +76562,7 @@ }, { "name": "not_available_message", - "description": "Message to display when the product is not available with this selected option.", + "description": "Shortage or unavailability message for the line; null when the item is salable.", "args": [], "type": { "kind": "SCALAR", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 74738c0f4..26b3b52be 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -10384,7 +10384,7 @@ definitions: host: https://.api.commerce.adobe.com/ info: title: Adobe Commerce as a Cloud Service - version: April 2026 + version: May 2026 description: "$ref": "intro/accs-intro.md" paths: diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index 505742db5..65caaecf6 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -115,30 +115,30 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", - "total_quantity": 987.65, - "uid": 4, - "updated_at": "xyz789" + "total_quantity": 123.45, + "uid": "4", + "updated_at": "abc123" } } } @@ -227,7 +227,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -350,9 +350,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -659,10 +659,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": [4] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -675,7 +672,7 @@ mutation addRequisitionListItemsToCart( AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } } } @@ -813,7 +810,10 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": 4, "wishlistItemIds": ["4"]} +{ + "wishlistId": "4", + "wishlistItemIds": ["4"] +} ``` ##### Response @@ -983,7 +983,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -1084,6 +1084,52 @@ mutation approvePurchaseOrders($input: PurchaseOrdersActionInput!) { +### assignChildCompany + +Assign a child company to a parent company within the company relation hierarchy. + +**Response:** [`AssignChildCompanyOutput`](#assignchildcompanyoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`AssignChildCompanyInput!`](#assignchildcompanyinput) | An input object that defines which companies to relate. | + +#### Example + +##### Query + +```graphql +mutation assignChildCompany($input: AssignChildCompanyInput!) { + assignChildCompany(input: $input) { + company_hierarchy { + ...CompanyHierarchyFragment + } + } +} +``` + +##### Variables + +```json +{"input": AssignChildCompanyInput} +``` + +##### Response + +```json +{ + "data": { + "assignChildCompany": { + "company_hierarchy": CompanyHierarchy + } + } +} +``` + + + ### assignCompareListToCustomer Assign the specified compare list to the logged in customer. @@ -1114,7 +1160,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -1124,7 +1170,7 @@ mutation assignCompareListToCustomer($uid: ID!) { "data": { "assignCompareListToCustomer": { "compare_list": CompareList, - "result": true + "result": false } } } @@ -1228,12 +1274,12 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": false, + "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": false, @@ -1325,16 +1371,16 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1344,9 +1390,9 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": "4", "updated_at": "abc123" } @@ -1490,10 +1536,16 @@ mutation changeCustomerPassword( addressesV2 { ...CustomerAddressesFragment } + admin_assistance_actions { + ...AdminAssistanceActionsFragment + } allow_remote_shopping_assistance companies { ...UserCompaniesOutputFragment } + company_hierarchy { + ...CompanyHierarchyFragment + } compare_list { ...CompareListFragment } @@ -1586,8 +1638,8 @@ mutation changeCustomerPassword( ```json { - "currentPassword": "abc123", - "newPassword": "abc123" + "currentPassword": "xyz789", + "newPassword": "xyz789" } ``` @@ -1599,15 +1651,17 @@ mutation changeCustomerPassword( "changeCustomerPassword": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, + "admin_assistance_actions": AdminAssistanceActions, "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, + "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", - "default_billing": "abc123", - "default_shipping": "abc123", + "default_billing": "xyz789", + "default_shipping": "xyz789", "email": "xyz789", "firstname": "xyz789", "gender": 987, @@ -1620,14 +1674,14 @@ mutation changeCustomerPassword( "lastname": "xyz789", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, - "quote_enabled": false, + "purchase_orders_enabled": true, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1637,10 +1691,10 @@ mutation changeCustomerPassword( "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1727,7 +1781,7 @@ mutation clearWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -2029,7 +2083,7 @@ mutation contactUs($input: ContactUsInput!) { ##### Response ```json -{"data": {"contactUs": {"status": false}}} +{"data": {"contactUs": {"status": true}}} ``` @@ -2074,7 +2128,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, + "sourceRequisitionListUid": "4", "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } @@ -2141,7 +2195,7 @@ mutation copyProductsBetweenWishlists( ```json { "sourceWishlistUid": "4", - "destinationWishlistUid": 4, + "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2368,7 +2422,7 @@ mutation createCompareList($input: CreateCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -2439,25 +2493,25 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "xyz789", - "company": "xyz789", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": false, + "default_billing": true, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", "id": 987, - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", + "region_id": 987, + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": 4, "vat_id": "abc123" } } @@ -2630,8 +2684,8 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, - "currency_code": "xyz789", + "amount": 987.65, + "currency_code": "abc123", "id": "abc123", "mp_order_id": "xyz789", "status": "abc123" @@ -2698,7 +2752,7 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "abc123", - "description": "abc123", + "description": "xyz789", "name": "xyz789", "status": "ENABLED", "uid": "4", @@ -2796,7 +2850,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -2915,7 +2969,7 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -2959,7 +3013,7 @@ mutation deleteCompanyTeam($id: ID!) { ##### Response ```json -{"data": {"deleteCompanyTeam": {"success": false}}} +{"data": {"deleteCompanyTeam": {"success": true}}} ``` @@ -2991,13 +3045,13 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyUserV2": {"success": false}}} +{"data": {"deleteCompanyUserV2": {"success": true}}} ``` @@ -3029,13 +3083,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -3059,7 +3113,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": true}} +{"data": {"deleteCustomer": false}} ``` @@ -3265,7 +3319,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3275,7 +3329,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } } } @@ -3414,8 +3468,8 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] } ``` @@ -3463,7 +3517,7 @@ mutation deleteWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": "4"} +{"wishlistId": 4} ``` ##### Response @@ -3472,7 +3526,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": false, + "status": true, "wishlists": [Wishlist] } } @@ -3582,11 +3636,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": false, - "carrier_code": "abc123", + "carrier_code": "xyz789", "carrier_title": "abc123", - "error_message": "abc123", - "method_code": "abc123", - "method_title": "xyz789", + "error_message": "xyz789", + "method_code": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -3687,7 +3741,7 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu ### exchangeOtpForCustomerToken -Exchange a customer's one time password for a customer token. +Exchange one time login code for customer token. **Response:** [`CustomerToken`](#customertoken) @@ -3721,7 +3775,7 @@ mutation exchangeOtpForCustomerToken( ```json { "email": "xyz789", - "otp": "xyz789" + "otp": "abc123" } ``` @@ -3776,7 +3830,7 @@ mutation finishUpload($input: finishUploadInput!) { "data": { "finishUpload": { "key": "xyz789", - "message": "xyz789", + "message": "abc123", "success": false } } @@ -3875,7 +3929,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "xyz789" + "customer_token": "abc123" } } } @@ -3927,6 +3981,56 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom +### importSharedRequisitionList + +Import a shared requisition list into the current customer account. + +**Response:** [`ImportSharedRequisitionListOutput`](#importsharedrequisitionlistoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `token` - [`String!`](#string) | The token for the shared requisition list. | + +#### Example + +##### Query + +```graphql +mutation importSharedRequisitionList($token: String!) { + importSharedRequisitionList(token: $token) { + requisition_list { + ...RequisitionListFragment + } + user_errors { + ...ShareRequisitionListUserErrorFragment + } + } +} +``` + +##### Variables + +```json +{"token": "xyz789"} +``` + +##### Response + +```json +{ + "data": { + "importSharedRequisitionList": { + "requisition_list": RequisitionList, + "user_errors": [ShareRequisitionListUserError] + } + } +} +``` + + + ### initiateUpload **Response:** [`initiateUploadOutput`](#initiateuploadoutput) @@ -3963,9 +4067,9 @@ mutation initiateUpload($input: initiateUploadInput!) { { "data": { "initiateUpload": { - "expires_at": "xyz789", - "key": "abc123", - "upload_url": "xyz789" + "expires_at": "abc123", + "key": "xyz789", + "upload_url": "abc123" } } } @@ -4059,7 +4163,7 @@ mutation mergeCarts( ```json { "source_cart_id": "abc123", - "destination_cart_id": "xyz789" + "destination_cart_id": "abc123" } ``` @@ -4087,11 +4191,11 @@ mutation mergeCarts( "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -4149,7 +4253,7 @@ mutation moveCartItemsToGiftRegistry( "data": { "moveCartItemsToGiftRegistry": { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } } @@ -4314,7 +4418,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4414,13 +4518,13 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -4428,14 +4532,14 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "abc123", "template_id": 4, "total_quantity": 123.45, - "uid": "4", + "uid": 4, "updated_at": "xyz789" } } @@ -4719,7 +4823,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "abc123" } } @@ -4925,7 +5029,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -4972,10 +5076,7 @@ mutation removeGiftRegistryItems( ##### Variables ```json -{ - "giftRegistryUid": "4", - "itemsUid": ["4"] -} +{"giftRegistryUid": "4", "itemsUid": [4]} ``` ##### Response @@ -5030,7 +5131,7 @@ mutation removeGiftRegistryRegistrants( ```json { "giftRegistryUid": "4", - "registrantsUid": ["4"] + "registrantsUid": [4] } ``` @@ -5211,14 +5312,14 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -5231,9 +5332,9 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -5286,7 +5387,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "data": { "removeProductsFromCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], "uid": "4" } @@ -5335,7 +5436,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": "4", "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": [4]} ``` ##### Response @@ -5422,7 +5523,7 @@ mutation removeRewardPointsFromCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -5789,29 +5890,29 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, + "status": "xyz789", + "template_id": "4", "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -5930,13 +6031,13 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"resendConfirmationEmail": false}} +{"data": {"resendConfirmationEmail": true}} ``` @@ -5977,7 +6078,7 @@ mutation resetPassword( ```json { - "email": "abc123", + "email": "xyz789", "resetPasswordToken": "xyz789", "newPassword": "xyz789" } @@ -5986,7 +6087,7 @@ mutation resetPassword( ##### Response ```json -{"data": {"resetPassword": true}} +{"data": {"resetPassword": false}} ``` @@ -6131,7 +6232,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -6140,7 +6241,7 @@ mutation setCartAsInactive($cartId: String!) { { "data": { "setCartAsInactive": { - "error": "xyz789", + "error": "abc123", "success": false } } @@ -6891,10 +6992,10 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -6905,10 +7006,10 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": "4", - "total_quantity": 987.65, - "uid": "4", + "total_quantity": 123.45, + "uid": 4, "updated_at": "xyz789" } } @@ -7034,16 +7135,16 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "setQuoteTemplateExpirationDate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": false, + "is_min_max_qty_used": true, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -7054,10 +7155,10 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, - "total_quantity": 987.65, + "template_id": "4", + "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -7143,13 +7244,13 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -7164,7 +7265,7 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "status": "abc123", "template_id": 4, "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -7305,6 +7406,98 @@ mutation shareGiftRegistry( +### shareRequisitionListByEmail + +Share a requisition list with company colleagues via email using a secure link. + +**Response:** [`ShareRequisitionListByEmailOutput`](#sharerequisitionlistbyemailoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`ShareRequisitionListByEmailInput!`](#sharerequisitionlistbyemailinput) | | + +#### Example + +##### Query + +```graphql +mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) { + shareRequisitionListByEmail(input: $input) { + sent_count + user_errors { + ...ShareRequisitionListUserErrorFragment + } + } +} +``` + +##### Variables + +```json +{"input": ShareRequisitionListByEmailInput} +``` + +##### Response + +```json +{ + "data": { + "shareRequisitionListByEmail": { + "sent_count": 123, + "user_errors": [ShareRequisitionListUserError] + } + } +} +``` + + + +### shareRequisitionListByToken + +Share a requisition list by issuing a token for colleagues in the same company. Use the token to build a shareable link on the storefront. + +**Response:** [`ShareRequisitionListByTokenOutput`](#sharerequisitionlistbytokenoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | + +#### Example + +##### Query + +```graphql +mutation shareRequisitionListByToken($requisitionListUid: ID!) { + shareRequisitionListByToken(requisitionListUid: $requisitionListUid) { + token + } +} +``` + +##### Variables + +```json +{"requisitionListUid": 4} +``` + +##### Response + +```json +{ + "data": { + "shareRequisitionListByToken": { + "token": "xyz789" + } + } +} +``` + + + ### submitNegotiableQuoteTemplateForReview Accept an existing negotiable quote template. @@ -7382,30 +7575,30 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "xyz789", + "created_at": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 987.65, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -7574,7 +7767,53 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": true}} +{"data": {"syncPaymentOrder": false}} +``` + + + +### unassignChildCompany + +Unassign a child company from its parent company within the company relation hierarchy. + +**Response:** [`UnassignChildCompanyOutput`](#unassignchildcompanyoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`UnassignChildCompanyInput!`](#unassignchildcompanyinput) | An input object that defines which company to unassign. | + +#### Example + +##### Query + +```graphql +mutation unassignChildCompany($input: UnassignChildCompanyInput!) { + unassignChildCompany(input: $input) { + company_hierarchy { + ...CompanyHierarchyFragment + } + } +} +``` + +##### Variables + +```json +{"input": UnassignChildCompanyInput} +``` + +##### Response + +```json +{ + "data": { + "unassignChildCompany": { + "company_hierarchy": CompanyHierarchy + } + } +} ``` @@ -7617,7 +7856,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { "data": { "unsubscribeProductAlertPrice": { "message": "abc123", - "success": true + "success": false } } } @@ -7651,7 +7890,7 @@ mutation unsubscribeProductAlertPriceAll { "data": { "unsubscribeProductAlertPriceAll": { "message": "abc123", - "success": true + "success": false } } } @@ -7730,8 +7969,8 @@ mutation unsubscribeProductAlertStockAll { { "data": { "unsubscribeProductAlertStockAll": { - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -8062,27 +8301,27 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, - "default_shipping": false, + "default_billing": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": 123, + "id": 987, "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "region_id": 123, + "street": ["abc123"], + "suffix": "abc123", + "telephone": "xyz789", + "uid": 4, + "vat_id": "xyz789" } } } @@ -8159,26 +8398,26 @@ mutation updateCustomerAddressV2( { "data": { "updateCustomerAddressV2": { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": true, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", + "telephone": "xyz789", + "uid": 4, "vat_id": "xyz789" } } @@ -8225,7 +8464,7 @@ mutation updateCustomerEmail( ```json { "email": "xyz789", - "password": "abc123" + "password": "xyz789" } ``` @@ -8368,7 +8607,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "items": [UpdateGiftRegistryItemInput] } ``` @@ -8424,7 +8663,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -8575,7 +8814,7 @@ mutation updateProductsInWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "wishlistItems": [WishlistItemUpdateInput] } ``` @@ -8649,13 +8888,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", + "created_at": "abc123", "created_by": "abc123", - "description": "xyz789", + "description": "abc123", "name": "xyz789", "status": "ENABLED", "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -8700,7 +8939,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "input": UpdateRequisitionListInput } ``` @@ -8817,8 +9056,8 @@ mutation updateWishlist( ```json { - "wishlistId": 4, - "name": "xyz789", + "wishlistId": "4", + "name": "abc123", "visibility": "PUBLIC" } ``` @@ -8830,7 +9069,7 @@ mutation updateWishlist( "data": { "updateWishlist": { "name": "xyz789", - "uid": 4, + "uid": "4", "visibility": "PUBLIC" } } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index 9e06474de..ea65f1d2c 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -290,6 +290,10 @@ query availableStores($useCurrentGroup: Boolean) { quote_minimum_amount quote_minimum_amount_message required_character_classes_number + requisition_list_share_link_validity_days + requisition_list_share_max_recipients + requisition_list_share_storefront_path + requisition_list_sharing_enabled returns_enabled root_category_uid sales_fixed_product_tax_display_setting @@ -301,6 +305,9 @@ query availableStores($useCurrentGroup: Boolean) { secure_base_url share_active_segments share_applied_cart_rule + shopping_assistance_checkbox_title + shopping_assistance_checkbox_tooltip + shopping_assistance_enabled shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -333,7 +340,7 @@ query availableStores($useCurrentGroup: Boolean) { ##### Variables ```json -{"useCurrentGroup": true} +{"useCurrentGroup": false} ``` ##### Response @@ -344,64 +351,64 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "allow_company_registration": true, - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", - "allow_items": "xyz789", - "allow_order": "xyz789", - "allow_printed_card": "xyz789", + "allow_items": "abc123", + "allow_order": "abc123", + "allow_printed_card": "abc123", "autocomplete_on_storefront": true, - "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "abc123", - "base_static_url": "abc123", - "base_url": "xyz789", + "base_currency_code": "xyz789", + "base_link_url": "xyz789", + "base_media_url": "xyz789", + "base_static_url": "xyz789", + "base_url": "abc123", "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "xyz789", + "cart_merge_preference": "abc123", "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "abc123", + "cart_summary_display_quantity": 123, + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, + "category_url_suffix": "abc123", + "check_money_order_enable_for_specific_countries": true, "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "xyz789", - "check_money_order_max_order_total": "xyz789", - "check_money_order_min_order_total": "abc123", + "check_money_order_max_order_total": "abc123", + "check_money_order_min_order_total": "xyz789", "check_money_order_new_order_status": "xyz789", "check_money_order_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "abc123", + "check_money_order_send_check_to": "xyz789", "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", - "company_credit_enabled": true, - "company_enabled": true, + "company_credit_enabled": false, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "abc123", "contact_enabled": false, - "countries_with_required_region": "abc123", + "countries_with_required_region": "xyz789", "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, "default_country": "abc123", "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 987, - "display_shipping_prices": 123, + "display_product_prices_in_catalog": 123, + "display_shipping_prices": 987, "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", - "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_apply_tax_to_fpt": false, + "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 123, "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, - "graphql_share_customer_group": false, + "graphql_share_customer_group": true, "grid_per_page": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", "is_checkout_agreements_enabled": true, - "is_default_store": false, - "is_default_store_group": false, + "is_default_store": true, + "is_default_store_group": true, "is_guest_checkout_enabled": true, "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": true, @@ -410,25 +417,25 @@ query availableStores($useCurrentGroup: Boolean) { "list_per_page": 123, "list_per_page_values": "abc123", "locale": "abc123", - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_general_publish_history": "abc123", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "abc123", - "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", + "magento_reward_points_newsletter": "abc123", + "magento_reward_points_order": "abc123", + "magento_reward_points_register": "abc123", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "abc123", - "max_items_in_order_summary": 123, + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "xyz789", + "max_items_in_order_summary": 987, "maximum_number_of_wishlists": "abc123", - "minicart_display": false, - "minicart_max_items": 987, - "minimum_password_length": "abc123", + "minicart_display": true, + "minicart_max_items": 123, + "minimum_password_length": "xyz789", "newsletter_enabled": false, "optional_zip_countries": "abc123", "order_cancellation_enabled": true, @@ -436,54 +443,61 @@ query availableStores($useCurrentGroup: Boolean) { CancellationReason ], "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 123, - "orders_invoices_credit_memos_display_shipping_amount": 123, - "orders_invoices_credit_memos_display_subtotal": 987, + "orders_invoices_credit_memos_display_grandtotal": false, + "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": true, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "abc123", - "quickorder_active": true, - "quote_minimum_amount": 987.65, - "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "abc123", + "product_url_suffix": "xyz789", + "quickorder_active": false, + "quote_minimum_amount": 123.45, + "quote_minimum_amount_message": "abc123", + "required_character_classes_number": "xyz789", + "requisition_list_share_link_validity_days": 987, + "requisition_list_share_max_recipients": 987, + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": true, "returns_enabled": "xyz789", - "root_category_uid": 4, + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "xyz789", + "secure_base_link_url": "abc123", "secure_base_media_url": "xyz789", "secure_base_static_url": "xyz789", "secure_base_url": "xyz789", "share_active_segments": true, - "share_applied_cart_rule": true, + "share_applied_cart_rule": false, + "shopping_assistance_checkbox_title": "xyz789", + "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_enabled": true, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": false, + "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, - "shopping_cart_display_subtotal": 123, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, - "store_code": "4", - "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 123, + "shopping_cart_display_zero_tax": true, + "store_code": 4, + "store_group_code": "4", + "store_group_name": "abc123", + "store_name": "abc123", + "store_sort_order": 987, "timezone": "xyz789", - "title_separator": "xyz789", + "title_separator": "abc123", "use_store_in_url": true, - "website_code": "4", + "website_code": 4, "website_name": "xyz789", "weight_unit": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "abc123" + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "xyz789" } ] } @@ -588,19 +602,19 @@ query cart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "id": 4, - "is_virtual": true, + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -648,6 +662,7 @@ query categories( level name parentId + position path roles urlKey @@ -663,7 +678,7 @@ query categories( ```json { "ids": ["abc123"], - "roles": ["abc123"], + "roles": ["xyz789"], "subtree": Subtree } ``` @@ -675,97 +690,20 @@ query categories( "data": { "categories": [ { - "availableSortBy": ["xyz789"], + "availableSortBy": ["abc123"], "children": ["xyz789"], "defaultSortBy": "abc123", "id": 4, - "level": 123, + "level": 987, "name": "abc123", - "parentId": "abc123", + "parentId": "xyz789", + "position": 987, "path": "abc123", "roles": ["abc123"], - "urlKey": "abc123", + "urlKey": "xyz789", "urlPath": "xyz789", "count": 987, - "title": "abc123" - } - ] - } -} -``` - - - -### categoryTree - -Retrieves category tree nodes, optionally filtered by family, slugs and limited by depth. - -**Response:** [`[CategoryTreeView]`](#categorytreeview) - -#### Arguments - -| Name | Description | -|------|-------------| -| `family` - [`String`](#string) | The product family to retrieve the category tree for. Ex: clothing, electronics, books | -| `slugs` - [`[String!]`](#string) | The slugs of the categories to retrieve the category tree for. Ex: men/clothing/shorts | -| `depth` - [`Int`](#int) | The depth of the category tree to retrieve. When used without an initial slug, it will specify the maximum level allowed for a category. When used with a starting slug, it specifies depth from that slug, counting the slug itself as level 1. | - -#### Example - -##### Query - -```graphql -query categoryTree( - $family: String, - $slugs: [String!], - $depth: Int -) { - categoryTree( - family: $family, - slugs: $slugs, - depth: $depth - ) { - slug - name - description - metaTags { - ...CategoryMetaTagsFragment - } - images { - ...CategoryImageFragment - } - level - parentSlug - childrenSlugs - } -} -``` - -##### Variables - -```json -{ - "family": "xyz789", - "slugs": ["xyz789"], - "depth": 123 -} -``` - -##### Response - -```json -{ - "data": { - "categoryTree": [ - { - "slug": "xyz789", - "name": "xyz789", - "description": "abc123", - "metaTags": CategoryMetaTags, - "images": [CategoryImage], - "level": 123, - "parentSlug": "xyz789", - "childrenSlugs": ["xyz789"] + "title": "xyz789" } ] } @@ -805,10 +743,10 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, + "agreement_id": 987, "checkbox_text": "xyz789", - "content": "abc123", - "content_height": "abc123", + "content": "xyz789", + "content_height": "xyz789", "is_html": false, "mode": "AUTO", "name": "xyz789" @@ -942,10 +880,10 @@ query company { "email": "xyz789", "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123", - "payment_methods": ["abc123"], - "reseller_id": "abc123", + "payment_methods": ["xyz789"], + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -954,7 +892,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -1008,7 +946,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1050,9 +988,9 @@ query countries { { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "xyz789", + "full_name_locale": "abc123", "id": "xyz789", - "three_letter_abbreviation": "abc123", + "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "abc123" } ] @@ -1107,10 +1045,10 @@ query country($id: String) { "country": { "available_regions": [Region], "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "abc123" + "full_name_locale": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "xyz789" } } } @@ -1153,9 +1091,9 @@ query currency { "xyz789" ], "base_currency_code": "abc123", - "base_currency_symbol": "abc123", - "default_display_currency_code": "abc123", - "default_display_currency_symbol": "xyz789", + "base_currency_symbol": "xyz789", + "default_display_currency_code": "xyz789", + "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } } @@ -1233,10 +1171,16 @@ query customer { addressesV2 { ...CustomerAddressesFragment } + admin_assistance_actions { + ...AdminAssistanceActionsFragment + } allow_remote_shopping_assistance companies { ...UserCompaniesOutputFragment } + company_hierarchy { + ...CompanyHierarchyFragment + } compare_list { ...CompareListFragment } @@ -1333,24 +1277,26 @@ query customer { "customer": { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": true, + "admin_assistance_actions": AdminAssistanceActions, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, + "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", + "date_of_birth": "abc123", "default_billing": "abc123", - "default_shipping": "abc123", + "default_shipping": "xyz789", "email": "xyz789", "firstname": "xyz789", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": "4", + "id": 4, "is_subscribed": false, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", "middlename": "abc123", "orders": CustomerOrders, @@ -1361,7 +1307,7 @@ query customer { "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, "purchase_orders_enabled": true, - "quote_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1370,11 +1316,11 @@ query customer { "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1468,19 +1414,19 @@ query customerCart { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", - "is_virtual": false, + "id": 4, + "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } } } @@ -1607,13 +1553,17 @@ query customerSegments($cartId: String!) { ##### Variables ```json -{"cartId": "abc123"} +{"cartId": "xyz789"} ``` ##### Response ```json -{"data": {"customerSegments": [{"uid": 4}]}} +{ + "data": { + "customerSegments": [{"uid": "4"}] + } +} ``` @@ -1720,7 +1670,7 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "abc123" } ``` @@ -1731,10 +1681,10 @@ query getPaymentOrder( { "data": { "getPaymentOrder": { - "id": "xyz789", + "id": "abc123", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } } } @@ -1862,7 +1812,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "giftCardAccount": { "balance": Money, "code": "abc123", - "expiration_date": "xyz789" + "expiration_date": "abc123" } } } @@ -1931,10 +1881,10 @@ query giftRegistry($giftRegistryUid: ID!) { "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "xyz789", + "message": "xyz789", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -1980,7 +1930,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -1990,12 +1940,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": "4", - "location": "xyz789", + "event_date": "abc123", + "event_title": "abc123", + "gift_registry_uid": 4, + "location": "abc123", "name": "abc123", - "type": "abc123" + "type": "xyz789" } ] } @@ -2047,10 +1997,10 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "xyz789", + "event_title": "abc123", "gift_registry_uid": 4, - "location": "abc123", - "name": "xyz789", + "location": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -2104,8 +2054,8 @@ query giftRegistryTypeSearch( ```json { "firstName": "xyz789", - "lastName": "abc123", - "giftRegistryTypeUid": "4" + "lastName": "xyz789", + "giftRegistryTypeUid": 4 } ``` @@ -2116,11 +2066,11 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "abc123", "gift_registry_uid": 4, "location": "xyz789", - "name": "xyz789", + "name": "abc123", "type": "abc123" } ] @@ -2162,8 +2112,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", - "uid": 4 + "label": "abc123", + "uid": "4" } ] } @@ -2191,6 +2141,7 @@ Retrieve guest order details based on number, email and billing last name. ```graphql query guestOrder($input: GuestOrderInformationInput!) { guestOrder(input: $input) { + admin_assisted_order applied_coupons { ...AppliedCouponFragment } @@ -2274,36 +2225,37 @@ query guestOrder($input: GuestOrderInformationInput!) { { "data": { "guestOrder": { + "admin_assisted_order": 123, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "xyz789", + "carrier": "abc123", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "xyz789", - "order_date": "xyz789", + "number": "abc123", + "order_date": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", + "shipping_method": "abc123", "status": "abc123", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2331,6 +2283,7 @@ Retrieve guest order details based on token. ```graphql query guestOrderByToken($input: OrderTokenInput!) { guestOrderByToken(input: $input) { + admin_assisted_order applied_coupons { ...AppliedCouponFragment } @@ -2414,6 +2367,7 @@ query guestOrderByToken($input: OrderTokenInput!) { { "data": { "guestOrderByToken": { + "admin_assisted_order": 987, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], @@ -2425,11 +2379,11 @@ query guestOrderByToken($input: OrderTokenInput!) { "customer_info": OrderCustomerInfo, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], - "is_virtual": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, @@ -2442,7 +2396,7 @@ query guestOrderByToken($input: OrderTokenInput!) { "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "abc123", + "status": "xyz789", "token": "abc123", "total": OrderTotal } @@ -2479,13 +2433,13 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -2517,13 +2471,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} ``` @@ -2555,7 +2509,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Variables ```json -{"name": "abc123"} +{"name": "xyz789"} ``` ##### Response @@ -2599,7 +2553,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}} ``` @@ -2631,13 +2585,13 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response ```json -{"data": {"isEmailAvailable": {"is_email_available": true}}} +{"data": {"isEmailAvailable": {"is_email_available": false}}} ``` @@ -2679,8 +2633,8 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "isSubscribedProductAlertPrice": { - "isSubscribed": false, - "message": "xyz789" + "isSubscribed": true, + "message": "abc123" } } } @@ -2725,65 +2679,13 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { { "data": { "isSubscribedProductAlertStock": { - "isSubscribed": false, - "message": "abc123" - } - } -} -``` - - - -### navigation - -Retrieves the navigation tree for a given product family. - -**Response:** [`[CategoryNavigationView]`](#categorynavigationview) - -#### Arguments - -| Name | Description | -|------|-------------| -| `family` - [`String!`](#string) | The product family to retrieve the navigation tree for. For example, clothing, electronics or books | - -#### Example - -##### Query - -```graphql -query navigation($family: String!) { - navigation(family: $family) { - slug - name - children { - ...CategoryNavigationViewFragment + "isSubscribed": true, + "message": "xyz789" } } } ``` -##### Variables - -```json -{"family": "xyz789"} -``` - -##### Response - -```json -{ - "data": { - "navigation": [ - { - "slug": "xyz789", - "name": "xyz789", - "children": [CategoryNavigationView] - } - ] - } -} -``` - ### negotiableQuote @@ -2875,9 +2777,9 @@ query negotiableQuote($uid: ID!) { "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], "name": "xyz789", "order": CustomerOrder, @@ -2889,10 +2791,10 @@ query negotiableQuote($uid: ID!) { ], "status": "SUBMITTED", "template_id": 4, - "template_name": "abc123", + "template_name": "xyz789", "total_quantity": 987.65, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -2966,7 +2868,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": 4} +{"templateId": "4"} ``` ##### Response @@ -2977,8 +2879,8 @@ query negotiableQuoteTemplate($templateId: ID!) { "negotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, @@ -2986,21 +2888,21 @@ query negotiableQuoteTemplate($templateId: ID!) { "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", - "total_quantity": 987.65, - "uid": 4, - "updated_at": "xyz789" + "status": "xyz789", + "template_id": 4, + "total_quantity": 123.45, + "uid": "4", + "updated_at": "abc123" } } } @@ -3226,7 +3128,7 @@ query pickupLocations( "pickupLocations": { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } } } @@ -3299,7 +3201,7 @@ query productSearch( "current_page": 1, "filter": [SearchClauseInput], "page_size": 20, - "phrase": "abc123", + "phrase": "xyz789", "sort": [ProductSearchSortInput] } ``` @@ -3314,8 +3216,8 @@ query productSearch( "items": [ProductSearchItem], "page_info": SearchResultPageInfo, "related_terms": ["abc123"], - "suggestions": ["xyz789"], - "total_count": 987, + "suggestions": ["abc123"], + "total_count": 123, "warnings": [ProductSearchWarning] } } @@ -3373,9 +3275,6 @@ query products($skus: [String]) { links { ...ProductViewLinkFragment } - categories { - ...CategoryProductViewFragment - } queryType visibility } @@ -3396,15 +3295,15 @@ query products($skus: [String]) { "products": [ { "addToCartAllowed": true, - "inStock": false, - "lowStock": true, + "inStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "xyz789", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", + "metaDescription": "abc123", "metaKeyword": "xyz789", "metaTitle": "xyz789", "name": "abc123", @@ -3413,10 +3312,9 @@ query products($skus: [String]) { "sku": "abc123", "externalId": "abc123", "url": "xyz789", - "urlKey": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], - "categories": [CategoryProductView], - "queryType": "xyz789", + "queryType": "abc123", "visibility": "xyz789" } ] @@ -3464,7 +3362,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -3515,7 +3413,7 @@ query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) { { "configurations": ReCaptchaConfiguration, "form_type": "PLACE_ORDER", - "is_enabled": true + "is_enabled": false } ] } @@ -3555,14 +3453,14 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "abc123", - "failure_message": "abc123", + "badge_position": "xyz789", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": true, + "is_enabled": false, "language_code": "xyz789", - "minimum_score": 987.65, - "theme": "abc123", - "website_key": "abc123" + "minimum_score": 123.45, + "theme": "xyz789", + "website_key": "xyz789" } } } @@ -3583,6 +3481,7 @@ Get Recommendations | `cartSkus` - [`[String]`](#string) | SKUs of products in the cart | | `category` - [`String`](#string) | Category currently being viewed | | `currentSku` - [`String`](#string) | SKU of the product currently being viewed on PDP | +| `currentProduct` - [`CurrentProductInput`](#currentproductinput) | Current product context from PDP (SKU, price, category, etc.) | | `pageType` - [`PageType`](#pagetype) | Type of page on which recommendations are requested | | `userPurchaseHistory` - [`[PurchaseHistory]`](#purchasehistory) | User purchase history with timestamp | | `userViewHistory` - [`[ViewHistory]`](#viewhistory) | User view history with timestamp | @@ -3597,6 +3496,7 @@ query recommendations( $cartSkus: [String], $category: String, $currentSku: String, + $currentProduct: CurrentProductInput, $pageType: PageType, $userPurchaseHistory: [PurchaseHistory], $userViewHistory: [ViewHistory], @@ -3606,6 +3506,7 @@ query recommendations( cartSkus: $cartSkus, category: $category, currentSku: $currentSku, + currentProduct: $currentProduct, pageType: $pageType, userPurchaseHistory: $userPurchaseHistory, userViewHistory: $userViewHistory, @@ -3625,7 +3526,8 @@ query recommendations( { "cartSkus": ["abc123"], "category": "abc123", - "currentSku": "abc123", + "currentSku": "xyz789", + "currentProduct": CurrentProductInput, "pageType": "CMS", "userPurchaseHistory": [PurchaseHistory], "userViewHistory": [ViewHistory], @@ -3639,74 +3541,6 @@ query recommendations( { "data": { "recommendations": { - "results": [RecommendationUnit], - "totalResults": 123 - } - } -} -``` - - - -### recommendationsByUnitIds - -**Response:** [`Recommendations`](#recommendations) - -#### Arguments - -| Name | Description | -|------|-------------| -| `unitIds` - [`[String!]!`](#string) | List unit IDs of preconfigured units | -| `currentSku` - [`String`](#string) | SKU of the product currently being viewed on PDP | -| `userPurchaseHistory` - [`[PurchaseHistory]`](#purchasehistory) | User purchase history with timestamp | -| `userViewHistory` - [`[ViewHistory]`](#viewhistory) | User view history with timestamp | -| `cartSkus` - [`[String]`](#string) | SKUs of products in the cart | - -#### Example - -##### Query - -```graphql -query recommendationsByUnitIds( - $unitIds: [String!]!, - $currentSku: String, - $userPurchaseHistory: [PurchaseHistory], - $userViewHistory: [ViewHistory], - $cartSkus: [String] -) { - recommendationsByUnitIds( - unitIds: $unitIds, - currentSku: $currentSku, - userPurchaseHistory: $userPurchaseHistory, - userViewHistory: $userViewHistory, - cartSkus: $cartSkus - ) { - results { - ...RecommendationUnitFragment - } - totalResults - } -} -``` - -##### Variables - -```json -{ - "unitIds": ["abc123"], - "currentSku": "abc123", - "userPurchaseHistory": [PurchaseHistory], - "userViewHistory": [ViewHistory], - "cartSkus": ["abc123"] -} -``` - -##### Response - -```json -{ - "data": { - "recommendationsByUnitIds": { "results": [RecommendationUnit], "totalResults": 987 } @@ -3772,9 +3606,6 @@ query refineProduct( links { ...ProductViewLinkFragment } - categories { - ...CategoryProductViewFragment - } queryType visibility } @@ -3785,7 +3616,7 @@ query refineProduct( ```json { - "optionIds": ["xyz789"], + "optionIds": ["abc123"], "sku": "xyz789" } ``` @@ -3797,28 +3628,27 @@ query refineProduct( "data": { "refineProduct": { "addToCartAllowed": false, - "inStock": false, - "lowStock": false, + "inStock": true, + "lowStock": true, "attributes": [ProductViewAttribute], "description": "xyz789", - "id": 4, + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", + "metaDescription": "xyz789", "metaKeyword": "xyz789", - "metaTitle": "xyz789", + "metaTitle": "abc123", "name": "xyz789", - "shortDescription": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "abc123", - "externalId": "abc123", - "url": "xyz789", + "sku": "xyz789", + "externalId": "xyz789", + "url": "abc123", "urlKey": "xyz789", "links": [ProductViewLink], - "categories": [CategoryProductView], "queryType": "xyz789", - "visibility": "abc123" + "visibility": "xyz789" } } } @@ -3826,45 +3656,29 @@ query refineProduct( -### searchCategory +### sharedRequisitionList -Search for categories by name with optional filtering and pagination. +View a shared requisition list when the receiver is logged in and belongs to the same company as the sender. -**Response:** [`SearchCategoryResultPage`](#searchcategoryresultpage) +**Response:** [`SharedRequisitionListOutput`](#sharedrequisitionlistoutput) #### Arguments | Name | Description | |------|-------------| -| `searchTerm` - [`String!`](#string) | The search term to match against category names. | -| `family` - [`String`](#string) | Optional product family filter to limit search results. For example, clothing, electronics or books. | -| `pageSize` - [`Int`](#int) | The number of results to return per page (default: 20). Default: `20` | -| `currentPage` - [`Int`](#int) | The page number to retrieve (1-based indexing, default: 1). Default: `1` | +| `token` - [`String!`](#string) | The share token which is extracted from the requisition list share link and acts as an identifier for the requisition list. | #### Example ##### Query ```graphql -query searchCategory( - $searchTerm: String!, - $family: String, - $pageSize: Int, - $currentPage: Int -) { - searchCategory( - searchTerm: $searchTerm, - family: $family, - pageSize: $pageSize, - currentPage: $currentPage - ) { - items { - ...CategoryTreeViewFragment - } - totalCount - pageInfo { - ...PageInfoFragment +query sharedRequisitionList($token: String!) { + sharedRequisitionList(token: $token) { + requisition_list { + ...RequisitionListFragment } + sender_name } } ``` @@ -3872,12 +3686,7 @@ query searchCategory( ##### Variables ```json -{ - "searchTerm": "abc123", - "family": "xyz789", - "pageSize": 20, - "currentPage": 1 -} +{"token": "abc123"} ``` ##### Response @@ -3885,10 +3694,9 @@ query searchCategory( ```json { "data": { - "searchCategory": { - "items": [CategoryTreeView], - "totalCount": 123, - "pageInfo": PageInfo + "sharedRequisitionList": { + "requisition_list": RequisitionList, + "sender_name": "xyz789" } } } @@ -4016,6 +3824,10 @@ query storeConfig { quote_minimum_amount quote_minimum_amount_message required_character_classes_number + requisition_list_share_link_validity_days + requisition_list_share_max_recipients + requisition_list_share_storefront_path + requisition_list_sharing_enabled returns_enabled root_category_uid sales_fixed_product_tax_display_setting @@ -4027,6 +3839,9 @@ query storeConfig { secure_base_url share_active_segments share_applied_cart_rule + shopping_assistance_checkbox_title + shopping_assistance_checkbox_tooltip + shopping_assistance_enabled shopping_cart_display_full_summary shopping_cart_display_grand_total shopping_cart_display_price @@ -4063,134 +3878,141 @@ query storeConfig { "data": { "storeConfig": { "allow_company_registration": true, - "allow_gift_receipt": "xyz789", + "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_items": "xyz789", "allow_order": "xyz789", "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "xyz789", - "base_media_url": "abc123", - "base_static_url": "abc123", + "autocomplete_on_storefront": false, + "base_currency_code": "abc123", + "base_link_url": "abc123", + "base_media_url": "xyz789", + "base_static_url": "xyz789", "base_url": "xyz789", "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "abc123", + "cart_gift_wrapping": "abc123", + "cart_merge_preference": "xyz789", "cart_printed_card": "abc123", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "xyz789", + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", + "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "abc123", + "check_money_order_enabled": true, + "check_money_order_make_check_payable_to": "xyz789", "check_money_order_max_order_total": "abc123", "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "xyz789", "check_money_order_send_check_to": "xyz789", - "check_money_order_sort_order": 123, + "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", "company_credit_enabled": true, "company_enabled": false, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, - "countries_with_required_region": "abc123", - "create_account_confirmation": false, + "configurable_thumbnail_source": "abc123", + "contact_enabled": true, + "countries_with_required_region": "xyz789", + "create_account_confirmation": true, "customer_access_token_lifetime": 987.65, "default_country": "abc123", "default_display_currency_code": "abc123", "display_product_prices_in_catalog": 987, - "display_shipping_prices": 987, - "display_state_if_optional": false, - "enable_multiple_wishlists": "xyz789", + "display_shipping_prices": 123, + "display_state_if_optional": true, + "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": true, "fixed_product_taxes_display_prices_in_emails": 123, - "fixed_product_taxes_display_prices_in_product_lists": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 123, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, + "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_sales_modules": 987, + "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": true, - "grid_per_page": 123, + "grid_per_page": 987, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, - "is_default_store": true, + "is_checkout_agreements_enabled": false, + "is_default_store": false, "is_default_store_group": false, "is_guest_checkout_enabled": true, "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "abc123", "list_mode": "xyz789", "list_per_page": 123, - "list_per_page_values": "xyz789", + "list_per_page_values": "abc123", "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", - "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_is_enabled": "xyz789", + "magento_reward_general_is_enabled_on_front": "xyz789", "magento_reward_general_min_points_balance": "xyz789", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "xyz789", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "abc123", - "magento_reward_points_order": "abc123", + "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "abc123", + "magento_reward_points_review": "xyz789", "magento_reward_points_review_limit": "abc123", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "xyz789", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": true, "optional_zip_countries": "xyz789", - "order_cancellation_enabled": false, + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": false, - "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_price": 123, "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": false, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "abc123", + "product_url_suffix": "xyz789", "quickorder_active": false, "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "xyz789", "required_character_classes_number": "xyz789", - "returns_enabled": "abc123", + "requisition_list_share_link_validity_days": 987, + "requisition_list_share_max_recipients": 987, + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": true, + "returns_enabled": "xyz789", "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "xyz789", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "xyz789", + "secure_base_link_url": "abc123", "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", - "share_active_segments": false, - "share_applied_cart_rule": false, - "shopping_cart_display_full_summary": false, + "secure_base_url": "abc123", + "share_active_segments": true, + "share_applied_cart_rule": true, + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "xyz789", + "shopping_assistance_enabled": true, + "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, + "shopping_cart_display_price": 987, "shopping_cart_display_shipping": 987, "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, - "store_code": "4", + "store_code": 4, "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "xyz789", + "store_group_name": "abc123", + "store_name": "abc123", "store_sort_order": 987, "timezone": "xyz789", "title_separator": "xyz789", - "use_store_in_url": true, + "use_store_in_url": false, "website_code": 4, "website_name": "abc123", "weight_unit": "abc123", @@ -4199,7 +4021,7 @@ query storeConfig { "zero_subtotal_new_order_status": "xyz789", "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, + "zero_subtotal_sort_order": 987, "zero_subtotal_title": "xyz789" } } @@ -4251,9 +4073,9 @@ query variants( ```json { "sku": "abc123", - "optionIds": ["xyz789"], - "pageSize": 123, - "cursor": "abc123" + "optionIds": ["abc123"], + "pageSize": 987, + "cursor": "xyz789" } ``` @@ -4264,7 +4086,7 @@ query variants( "data": { "variants": { "variants": [ProductViewVariant], - "cursor": "abc123" + "cursor": "xyz789" } } } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-1.md b/src/pages/includes/autogenerated/graphql-api-saas-types-1.md index ebbcfffab..533ff43f9 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-1.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-1.md @@ -49,7 +49,7 @@ Contains details about the cart after adding custom attributes to it items. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [DownloadableProductCartItemInput] } ``` @@ -94,9 +94,9 @@ Defines a new registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", + "email": "abc123", "firstname": "abc123", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -238,7 +238,7 @@ Contains the comment to be added to a purchase order. ```json { - "comment": "xyz789", + "comment": "abc123", "purchase_order_uid": "4" } ``` @@ -279,9 +279,9 @@ Defines the purchase order and cart to act on. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "purchase_order_uid": 4, - "replace_existing_cart_items": false + "replace_existing_cart_items": true } ``` @@ -410,8 +410,8 @@ Defines tracking information to be added to the return. ```json { - "carrier_uid": "4", - "return_uid": "4", + "carrier_uid": 4, + "return_uid": 4, "tracking_number": "abc123" } ``` @@ -459,13 +459,61 @@ Contains the resultant wish list and any error information. "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } ``` +### AdminAssistanceAction + +A single admin assistance action performed on behalf of the customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `action` - [`String!`](#string) | Action identifier, e.g. add_to_cart, place_order. | +| `date` - [`String!`](#string) | When the action occurred. | +| `details` - [`String`](#string) | Action related details, e.g. product SKUs, order id. | + +#### Example + +```json +{ + "action": "xyz789", + "date": "xyz789", + "details": "xyz789" +} +``` + + + +### AdminAssistanceActions + +Paginated admin assistance actions for the customer. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `items` - [`[AdminAssistanceAction]!`](#adminassistanceaction) | Admin assistance actions for the current page. | +| `page_info` - [`SearchResultPageInfo!`](#searchresultpageinfo) | Contains pagination metadata. | +| `total_count` - [`Int!`](#int) | The total count of admin assistance actions for the customer. | + +#### Example + +```json +{ + "items": [AdminAssistanceAction], + "page_info": SearchResultPageInfo, + "total_count": 123 +} +``` + + + ### Aggregation A bucket that contains information for each filterable option @@ -483,9 +531,9 @@ A bucket that contains information for each filterable option ```json { - "attribute": "xyz789", + "attribute": "abc123", "buckets": [Bucket], - "title": "xyz789", + "title": "abc123", "type": "INTELLIGENT" } ``` @@ -532,13 +580,13 @@ Identifies the data type of the aggregation ```json { "button_styles": ButtonStyles, - "code": "xyz789", - "is_visible": true, + "code": "abc123", + "is_visible": false, "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "sort_order": "xyz789", + "title": "xyz789" } ``` @@ -560,9 +608,9 @@ Apple Pay inputs ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "abc123", - "paypal_order_id": "xyz789" + "paypal_order_id": "abc123" } ``` @@ -604,9 +652,9 @@ Contains an applied gift card with applied and remaining balance. ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -695,8 +743,8 @@ Specifies the coupon code to apply to the cart. ```json { - "cart_id": "abc123", - "coupon_code": "xyz789" + "cart_id": "xyz789", + "coupon_code": "abc123" } ``` @@ -819,7 +867,7 @@ Contains applied gift cards with gift card code and amount. ```json { "applied_balance": Money, - "code": "abc123" + "code": "xyz789" } ``` @@ -856,7 +904,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -893,7 +941,7 @@ AreaInput defines the parameters which will be used for filter by specified loca #### Example ```json -{"radius": 987, "search_term": "xyz789"} +{"radius": 123, "search_term": "xyz789"} ``` @@ -946,14 +994,51 @@ Contains information about an asset video. { "asset_video": ProductMediaGalleryEntriesAssetVideo, "disabled": false, - "label": "abc123", + "label": "xyz789", "position": 123, - "url": "abc123" + "url": "xyz789" } ``` +### AssignChildCompanyInput + +Defines the input schema for assigning a child company to a parent company. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `child_company_id` - [`ID!`](#id) | The unique ID of the child company. | +| `parent_company_id` - [`ID!`](#id) | The unique ID of the parent company. | + +#### Example + +```json +{"child_company_id": 4, "parent_company_id": 4} +``` + + + +### AssignChildCompanyOutput + +Contains the response to the request to assign a child company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company hierarchy for the parent company. | + +#### Example + +```json +{"company_hierarchy": CompanyHierarchy} +``` + + + ### AssignCompareListToCustomerOutput Contains the results of the request to assign a compare list. @@ -1010,10 +1095,10 @@ List of all entity types. Populated by the modules introducing EAV entities. ```json { - "attribute_type": "abc123", + "attribute_type": "xyz789", "code": "4", "url": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1044,18 +1129,18 @@ An input object that specifies the filters used for attributes. ```json { - "is_comparable": true, - "is_filterable": false, + "is_comparable": false, + "is_filterable": true, "is_filterable_in_search": false, - "is_html_allowed_on_front": false, - "is_searchable": false, + "is_html_allowed_on_front": true, + "is_searchable": true, "is_used_for_customer_segment": true, "is_used_for_price_rules": true, "is_used_for_promo_rules": false, "is_visible_in_advanced_search": true, "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "used_in_product_listing": false + "is_wysiwyg_enabled": false, + "used_in_product_listing": true } ``` @@ -1110,7 +1195,7 @@ EAV attribute frontend input types. ```json { "attribute_type": "xyz789", - "code": 4, + "code": "4", "url": "xyz789", "value": "xyz789" } @@ -1153,7 +1238,7 @@ Specifies selected option for a select or multiselect attribute value. #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1186,7 +1271,7 @@ Base EAV implementation of CustomAttributeMetadataInterface. "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": true, - "is_unique": true, + "is_unique": false, "label": "xyz789", "options": [CustomAttributeOptionInterface] } @@ -1209,7 +1294,7 @@ Attribute metadata retrieval error. ```json { - "message": "xyz789", + "message": "abc123", "type": "ENTITY_NOT_FOUND" } ``` @@ -1276,8 +1361,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "is_default": true, - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -1296,7 +1381,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "abc123", + "label": "xyz789", "value": "abc123" } ``` @@ -1323,7 +1408,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1343,8 +1428,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "attribute_type": "xyz789", - "code": 4, + "attribute_type": "abc123", + "code": "4", "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1366,8 +1451,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "attribute_type": "abc123", - "code": "4", - "value": "abc123" + "code": 4, + "value": "xyz789" } ``` @@ -1419,7 +1504,7 @@ Specifies the value for attribute. #### Example ```json -{"attribute_type": "abc123", "code": 4} +{"attribute_type": "xyz789", "code": 4} ``` @@ -1482,7 +1567,7 @@ Defines the code and symbol of a currency that can be used for purchase orders. #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{"code": "AFN", "symbol": "xyz789"} ``` @@ -1505,7 +1590,7 @@ Describes a payment method that the shopper can use to pay for the order. ```json { "code": "xyz789", - "is_deferred": true, + "is_deferred": false, "oope_payment_method_config": OopePaymentMethodConfig, "title": "xyz789" } @@ -1538,10 +1623,10 @@ Contains details about the possible shipping methods and carriers. { "additional_data": [ShippingAdditionalData], "amount": Money, - "available": true, + "available": false, "carrier_code": "abc123", "carrier_title": "xyz789", - "error_message": "abc123", + "error_message": "xyz789", "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, @@ -1589,9 +1674,9 @@ Defines the billing address. { "address": CartAddressInput, "customer_address_id": 987, - "customer_address_uid": "4", - "same_as_shipping": true, - "use_for_shipping": false + "customer_address_uid": 4, + "same_as_shipping": false, + "use_for_shipping": true } ``` @@ -1619,9 +1704,9 @@ The billing address information "address_line_1": "abc123", "address_line_2": "abc123", "city": "abc123", - "country_code": "abc123", - "postal_code": "abc123", - "region": "abc123" + "country_code": "xyz789", + "postal_code": "xyz789", + "region": "xyz789" } ``` @@ -1659,16 +1744,16 @@ Contains details about the billing address. ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "fax": "abc123", "firstname": "xyz789", - "id": 987, - "lastname": "xyz789", + "id": 123, + "lastname": "abc123", "middlename": "abc123", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CartAddressRegion, "street": ["xyz789"], @@ -1711,11 +1796,11 @@ Contains details about an individual category that comprises a breadcrumb. ```json { - "category_level": 123, - "category_name": "abc123", - "category_uid": "4", + "category_level": 987, + "category_name": "xyz789", + "category_uid": 4, "category_url_key": "abc123", - "category_url_path": "abc123" + "category_url_path": "xyz789" } ``` @@ -1758,6 +1843,7 @@ An implementation for bundle product cart items. | Field Name | Description | |------------|-------------| | `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `bundle_options` - [`[SelectedBundleOption]!`](#selectedbundleoption) | An array containing the bundle options the shopper selected. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | @@ -1765,10 +1851,11 @@ An implementation for bundle product cart items. | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | | `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | | `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -1781,6 +1868,7 @@ An implementation for bundle product cart items. ```json { "available_gift_wrapping": [GiftWrapping], + "backorder_message": "xyz789", "bundle_options": [SelectedBundleOption], "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], @@ -1789,15 +1877,16 @@ An implementation for bundle product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "max_qty": 123.45, - "min_qty": 123.45, - "not_available_message": "xyz789", + "is_salable": true, + "max_qty": 987.65, + "min_qty": 987.65, + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -1828,12 +1917,12 @@ Defines bundle product options for `CreditMemoItemInterface`. "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` @@ -1866,10 +1955,10 @@ Defines bundle product options for `InvoiceItemInterface`. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 987.65 + "product_sku": "xyz789", + "quantity_invoiced": 123.45 } ``` @@ -1897,10 +1986,10 @@ Defines an individual item within a bundle product. ```json { "options": [BundleItemOption], - "position": 987, + "position": 123, "price_range": PriceRange, "required": true, - "sku": "abc123", + "sku": "xyz789", "title": "xyz789", "type": "xyz789", "uid": 4 @@ -1931,15 +2020,15 @@ Defines the characteristics that comprise a specific bundle item and its options ```json { - "can_change_quantity": true, + "can_change_quantity": false, "is_default": true, - "label": "abc123", - "position": 987, + "label": "xyz789", + "position": 123, "price": 987.65, "price_type": "FIXED", "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -1986,7 +2075,7 @@ Defines bundle product options for `OrderItemInterface`. "bundle_options": [ItemSelectedBundleOption], "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, @@ -1996,10 +2085,10 @@ Defines bundle product options for `OrderItemInterface`. "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 123.45, + "product_url_key": "xyz789", + "quantity_canceled": 987.65, "quantity_invoiced": 987.65, "quantity_ordered": 123.45, "quantity_refunded": 987.65, @@ -2074,54 +2163,54 @@ Defines basic features of a bundle product and contains multiple BundleItems. ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "dynamic_price": true, - "dynamic_sku": false, + "dynamic_sku": true, "dynamic_weight": false, - "gift_message_available": true, - "gift_wrapping_available": true, + "gift_message_available": false, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_keyword": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "abc123", + "name": "abc123", + "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_details": PriceDetails, "price_range": PriceRange, "price_tiers": [TierPrice], "price_view": "PRICE_RANGE", "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, "special_price": 987.65, - "special_to_date": "abc123", + "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 123.45 + "url_key": "abc123", + "weight": 987.65 } ``` @@ -2149,9 +2238,9 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", - "uid": "4" + "quantity": 987.65, + "sku": "abc123", + "uid": 4 } ``` @@ -2178,12 +2267,12 @@ Defines bundle product options for `ShipmentItemInterface`. ```json { "bundle_options": [ItemSelectedBundleOption], - "id": 4, + "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -2209,11 +2298,11 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 987.65 } @@ -2239,12 +2328,12 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "abc123", + "color": "xyz789", "height": 123, "label": "abc123", "layout": "abc123", - "shape": "abc123", - "tagline": false, + "shape": "xyz789", + "tagline": true, "use_default_height": true } ``` @@ -2267,7 +2356,7 @@ Specifies the quote template id of the quote template to cancel ```json { "cancellation_comment": "xyz789", - "template_id": "4" + "template_id": 4 } ``` @@ -2287,7 +2376,7 @@ Specifies the quote template id of the quote template to cancel ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "message": "xyz789" } ``` @@ -2330,7 +2419,7 @@ Defines the order to cancel. ```json { "order_id": "4", - "reason": "xyz789" + "reason": "abc123" } ``` @@ -2394,9 +2483,9 @@ Contains the updated customer order and error message if any. { "bin_details": CardBin, "card_expiry_month": "abc123", - "card_expiry_year": "abc123", + "card_expiry_year": "xyz789", "last_digits": "xyz789", - "name": "abc123" + "name": "xyz789" } ``` @@ -2434,7 +2523,7 @@ The card payment source information ```json { "billing_address": BillingAddressPaymentSourceInput, - "name": "abc123" + "name": "xyz789" } ``` @@ -2457,7 +2546,7 @@ The card payment source information ```json { "brand": "abc123", - "expiry": "abc123", + "expiry": "xyz789", "last_digits": "abc123" } ``` @@ -2506,19 +2595,19 @@ Contains the contents and other details about a guest or customer cart. "available_payment_methods": [AvailablePaymentMethod], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 987.65 + "total_quantity": 123.45 } ``` @@ -2539,8 +2628,8 @@ Contains details the country in a billing or shipping address. ```json { - "code": "xyz789", - "label": "xyz789" + "code": "abc123", + "label": "abc123" } ``` @@ -2576,23 +2665,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "xyz789", "firstname": "abc123", - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", "region": "xyz789", "region_id": 987, - "save_in_address_book": true, + "save_in_address_book": false, "street": ["abc123"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -2634,8 +2723,8 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", @@ -2644,12 +2733,12 @@ Defines the billing or shipping address to be applied to the cart. "id": 987, "lastname": "abc123", "middlename": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "abc123", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", "uid": "4", "vat_id": "xyz789" } @@ -2736,7 +2825,7 @@ Defines a cart item custom attributes. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_item_id": "abc123", "custom_attributes": [CustomAttributeInput] } @@ -2756,7 +2845,7 @@ Defines a cart item custom attributes. #### Example ```json -{"code": "UNDEFINED", "message": "xyz789"} +{"code": "UNDEFINED", "message": "abc123"} ``` @@ -2798,10 +2887,10 @@ Defines an item to be added to the cart. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", + "parent_sku": "abc123", "quantity": 123.45, - "selected_options": ["4"], - "sku": "abc123" + "selected_options": [4], + "sku": "xyz789" } ``` @@ -2815,13 +2904,15 @@ An interface for products in a cart. | Field Name | Description | |------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -2844,19 +2935,21 @@ An interface for products in a cart. ```json { + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "discount": [Discount], "errors": [CartItemError], - "is_available": false, + "is_available": true, + "is_salable": false, "max_qty": 123.45, "min_qty": 123.45, - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 987.65, - "uid": 4 + "quantity": 123.45, + "uid": "4" } ``` @@ -2919,8 +3012,8 @@ Contains details about the price of a selected customizable value. ```json { "type": "FIXED", - "units": "abc123", - "value": 123.45 + "units": "xyz789", + "value": 987.65 } ``` @@ -2948,7 +3041,7 @@ A single item to be updated. "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -2970,7 +3063,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -3042,7 +3135,7 @@ Contains tax information about an item in the cart. ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -3152,27 +3245,27 @@ Swatch attribute metadata. { "apply_to": ["SIMPLE"], "code": "4", - "default_value": "xyz789", + "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_comparable": false, - "is_filterable": true, + "is_filterable": false, "is_filterable_in_search": true, - "is_html_allowed_on_front": true, + "is_html_allowed_on_front": false, "is_required": false, "is_searchable": true, "is_unique": true, "is_used_for_price_rules": true, - "is_used_for_promo_rules": true, + "is_used_for_promo_rules": false, "is_visible_in_advanced_search": false, - "is_visible_on_front": false, + "is_visible_on_front": true, "is_wysiwyg_enabled": true, "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", "update_product_preview_image": true, - "use_product_image_for_swatch": false, + "use_product_image_for_swatch": true, "used_in_product_listing": true } ``` @@ -3197,9 +3290,9 @@ New category bucket for federation ```json { "count": 123, - "id": 4, - "path": "abc123", - "title": "abc123" + "id": "4", + "path": "xyz789", + "title": "xyz789" } ``` @@ -3222,33 +3315,7 @@ New category bucket for federation #### Example ```json -{"id": "4"} -``` - - - -### CategoryImage - -Represents an image associated with a category. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `url` - [`String!`](#string) | The URL where the image is hosted. | -| `label` - [`String`](#string) | A descriptive label or alt text for the image. | -| `roles` - [`[String]`](#string) | Standard predefined roles for the image. | -| `customRoles` - [`[String]`](#string) | Custom roles specific to the implementation. | - -#### Example - -```json -{ - "url": "xyz789", - "label": "abc123", - "roles": ["xyz789"], - "customRoles": ["abc123"] -} +{"id": 4} ``` @@ -3297,105 +3364,31 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children_count": "abc123", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 123.45, + "display_mode": "abc123", + "filter_price_range": 987.65, "image": "abc123", - "include_in_menu": 123, - "is_anchor": 123, - "landing_page": 123, - "level": 987, + "include_in_menu": 987, + "is_anchor": 987, + "landing_page": 987, + "level": 123, "meta_description": "xyz789", - "meta_keywords": "abc123", + "meta_keywords": "xyz789", "meta_title": "abc123", "name": "xyz789", - "path": "xyz789", + "path": "abc123", "path_in_store": "xyz789", - "position": 987, + "position": 123, "product_count": 987, "uid": 4, "url_key": "abc123", - "url_path": "abc123" -} -``` - - - -### CategoryMetaTags - -SEO metadata tags for the category. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `title` - [`String`](#string) | The page title for SEO purposes. | -| `description` - [`String`](#string) | The meta description for SEO purposes. | -| `keywords` - [`[String]`](#string) | Keywords associated with the category for SEO. | - -#### Example - -```json -{ - "title": "abc123", - "description": "xyz789", - "keywords": ["xyz789"] -} -``` - - - -### CategoryNavigationView - -Represents a category optimized for navigation menus, with nested children for building navigation trees. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `slug` - [`String!`](#string) | The unique URL-friendly identifier for the category. | -| `name` - [`String!`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `children` - [`[CategoryNavigationView]`](#categorynavigationview) | The direct child categories for building nested navigation menus. | - -#### Example - -```json -{ - "slug": "abc123", - "name": "xyz789", - "children": [CategoryNavigationView] -} -``` - - - -### CategoryProductView - -Represents category information associated with a product, including hierarchical parent relationships. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `name` - [`String!`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `slug` - [`String!`](#string) | The unique URL-friendly identifier for the category. | -| `level` - [`Int!`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | -| `parents` - [`[CategoryProductView!]`](#categoryproductview) | The ancestor categories in the hierarchy, ordered from root to immediate parent. | - -#### Example - -```json -{ - "name": "abc123", - "slug": "xyz789", - "level": 123, - "parents": [CategoryProductView] + "url_path": "xyz789" } ``` @@ -3439,65 +3432,31 @@ Contains the hierarchy of categories. ```json { - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", + "canonical_url": "xyz789", "children_count": "xyz789", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", - "description": "xyz789", - "display_mode": "xyz789", - "filter_price_range": 123.45, - "image": "abc123", - "include_in_menu": 123, - "is_anchor": 987, - "landing_page": 987, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "abc123", - "meta_title": "abc123", - "name": "abc123", - "path": "abc123", - "path_in_store": "abc123", - "position": 123, - "product_count": 987, - "uid": 4, - "url_key": "xyz789", - "url_path": "xyz789" -} -``` - - - -### CategoryTreeView - -Represents a category within a hierarchical tree structure, including parent and children relationships. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `slug` - [`String!`](#string) | The unique URL-friendly identifier for the category. | -| `name` - [`String!`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | -| `description` - [`String`](#string) | A detailed description of the category. | -| `metaTags` - [`CategoryMetaTags`](#categorymetatags) | SEO metadata tags for the category. | -| `images` - [`[CategoryImage]`](#categoryimage) | Visual images associated with the category. | -| `level` - [`Int`](#int) | The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | -| `parentSlug` - [`String`](#string) | The slug of the parent category, if any. | -| `childrenSlugs` - [`[String]`](#string) | The slugs of all direct child categories. Ex: men/clothing/shorts -> [men/clothing/shorts/athletic, men/clothing/shorts/swimwear] | - -#### Example - -```json -{ - "slug": "xyz789", - "name": "xyz789", - "description": "xyz789", - "metaTags": CategoryMetaTags, - "images": [CategoryImage], + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", + "description": "abc123", + "display_mode": "xyz789", + "filter_price_range": 123.45, + "image": "abc123", + "include_in_menu": 987, + "is_anchor": 987, + "landing_page": 987, "level": 123, - "parentSlug": "abc123", - "childrenSlugs": ["xyz789"] + "meta_description": "abc123", + "meta_keywords": "xyz789", + "meta_title": "abc123", + "name": "xyz789", + "path": "xyz789", + "path_in_store": "xyz789", + "position": 987, + "product_count": 123, + "uid": 4, + "url_key": "abc123", + "url_path": "xyz789" } ``` @@ -3518,6 +3477,7 @@ Represents a category. Contains information about a category, including the cate | `level` - [`Int`](#int) | The level of the category. The root category is a level 1 category. For example, men -> level 1, men/clothing -> level 2, men/clothing/shorts -> level 3 | | `name` - [`String`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | | `parentId` - [`String!`](#string) | Parent category ID. For example, `123`, `456` or `789`. | +| `position` - [`Int`](#int) | The position of the category in sort order. For example, `1`, `2`, `3` or `10`. | | `path` - [`String`](#string) | Category path. For example, `/electronics/laptops`, `/clothing/shirts` or `/books/fiction`. *(Deprecated: 'CategoryView' is deprecated for use as a Bucket in 'productSearch' facet (to be removed after Sep 1, 2024). Use 'CategoryBucket' instead.)* | | `roles` - [`[String!]!`](#string) | List of roles for the category. For example, `show_on_plp`, `show_in_pdp` or `show_in_search`. | | `urlKey` - [`String`](#string) | Category URL key. For example, `electronics`, `clothing` or `books`. | @@ -3529,17 +3489,18 @@ Represents a category. Contains information about a category, including the cate ```json { - "availableSortBy": ["abc123"], - "children": ["xyz789"], + "availableSortBy": ["xyz789"], + "children": ["abc123"], "defaultSortBy": "abc123", - "id": "4", + "id": 4, "level": 123, - "name": "abc123", - "parentId": "xyz789", - "path": "xyz789", - "roles": ["xyz789"], - "urlKey": "xyz789", - "urlPath": "xyz789", + "name": "xyz789", + "parentId": "abc123", + "position": 123, + "path": "abc123", + "roles": ["abc123"], + "urlKey": "abc123", + "urlPath": "abc123", "count": 987, "title": "xyz789" } @@ -3578,47 +3539,17 @@ Base interface defining essential category fields shared across all category vie "availableSortBy": ["xyz789"], "defaultSortBy": "abc123", "id": 4, - "level": 987, + "level": 123, "name": "abc123", "path": "abc123", - "roles": ["abc123"], - "urlKey": "xyz789", + "roles": ["xyz789"], + "urlKey": "abc123", "urlPath": "xyz789" } ``` -### CategoryViewV2 - -Base interface defining essential category fields shared across all category views. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `slug` - [`String!`](#string) | The unique URL-friendly identifier for the category. | -| `name` - [`String!`](#string) | Category name. For example, `Electronics`, `Clothing` or `Books`. | - -#### Possible Types - -| CategoryViewV2 Types | -|----------------| -| [`CategoryNavigationView`](#categorynavigationview) | -| [`CategoryProductView`](#categoryproductview) | -| [`CategoryTreeView`](#categorytreeview) | - -#### Example - -```json -{ - "slug": "abc123", - "name": "xyz789" -} -``` - - - ### CheckoutAgreement Defines details about an individual checkout agreement. @@ -3640,9 +3571,9 @@ Defines details about an individual checkout agreement. ```json { "agreement_id": 123, - "checkbox_text": "abc123", - "content": "xyz789", - "content_height": "abc123", + "checkbox_text": "xyz789", + "content": "abc123", + "content_height": "xyz789", "is_html": false, "mode": "AUTO", "name": "xyz789" @@ -3688,7 +3619,7 @@ An error encountered while adding an item to the cart. { "code": "REORDER_NOT_AVAILABLE", "message": "abc123", - "path": ["xyz789"] + "path": ["abc123"] } ``` @@ -3728,7 +3659,7 @@ Output of the request to clear the customer cart. #### Example ```json -{"cart": Cart, "status": true} +{"cart": Cart, "status": false} ``` @@ -3767,7 +3698,7 @@ Contains details about a failed close operation on a negotiable quote. ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -3803,7 +3734,7 @@ Defines the negotiable quotes to mark as closed. #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -3845,7 +3776,7 @@ Contains the closed negotiable quotes and other negotiable quotes the company us #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -3955,7 +3886,7 @@ Contains the output schema for a company. "legal_address": CompanyLegalAddress, "legal_name": "abc123", "name": "abc123", - "payment_methods": ["abc123"], + "payment_methods": ["xyz789"], "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, @@ -3965,7 +3896,7 @@ Contains the output schema for a company. "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } ``` @@ -3989,9 +3920,9 @@ Contains details about the access control list settings of a resource. ```json { "children": [CompanyAclResource], - "id": "4", + "id": 4, "sort_order": 123, - "text": "abc123" + "text": "xyz789" } ``` @@ -4022,8 +3953,8 @@ Defines the input schema for creating a company administrator. "firstname": "xyz789", "gender": 987, "job_title": "abc123", - "lastname": "abc123", - "telephone": "abc123" + "lastname": "xyz789", + "telephone": "xyz789" } ``` @@ -4045,7 +3976,7 @@ Describes a carrier-level shipping option available to the company. ```json { "code": "xyz789", - "title": "abc123" + "title": "xyz789" } ``` @@ -4060,6 +3991,7 @@ The minimal required information to identify and display the company. | Field Name | Description | |------------|-------------| | `id` - [`ID!`](#id) | The unique ID of a `Company` object. | +| `is_admin` - [`Boolean!`](#boolean) | Indicates whether the company is the admin (parent) company in the returned relation hierarchy. | | `legal_name` - [`String`](#string) | The full legal name of the company. | | `name` - [`String`](#string) | The name of the company. | | `status` - [`CompanyStatusEnum`](#companystatusenum) | The current status of the company. | @@ -4068,8 +4000,9 @@ The minimal required information to identify and display the company. ```json { - "id": "4", - "legal_name": "xyz789", + "id": 4, + "is_admin": false, + "legal_name": "abc123", "name": "xyz789", "status": "PENDING" } @@ -4099,9 +4032,9 @@ Defines the input schema for creating a new company. { "company_admin": CompanyAdminInput, "company_email": "xyz789", - "company_name": "xyz789", + "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, - "legal_name": "xyz789", + "legal_name": "abc123", "reseller_id": "xyz789", "vat_tax_id": "xyz789" } @@ -4128,7 +4061,7 @@ Contains company credit balances and limits. { "available_credit": Money, "credit_limit": Money, - "exceed_limit": false, + "exceed_limit": true, "outstanding_balance": Money } ``` @@ -4153,7 +4086,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -4204,7 +4137,7 @@ Contains details about a single company credit operation. { "amount": Money, "balance": CompanyCredit, - "custom_reference_number": "abc123", + "custom_reference_number": "xyz789", "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser @@ -4248,7 +4181,7 @@ Defines the administrator or company user that submitted a company credit operat #### Example ```json -{"name": "xyz789", "type": "CUSTOMER"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -4270,6 +4203,28 @@ Defines the administrator or company user that submitted a company credit operat +### CompanyHierarchy + +Defines a parent company and its direct child companies. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `children` - [`[CompanyBasicInfo]!`](#companybasicinfo) | An array of direct child companies. | +| `parent` - [`CompanyBasicInfo`](#companybasicinfo) | The parent company in the relation hierarchy. Null if the company has no parent. | + +#### Example + +```json +{ + "children": [CompanyBasicInfo], + "parent": CompanyBasicInfo +} +``` + + + ### CompanyInvitationInput Defines the input schema for accepting the company invitation. @@ -4286,7 +4241,7 @@ Defines the input schema for accepting the company invitation. ```json { - "code": "xyz789", + "code": "abc123", "role_id": 4, "user": CompanyInvitationUserInput } @@ -4330,11 +4285,11 @@ Company user attributes in the invitation. ```json { - "company_id": 4, - "customer_id": "4", - "job_title": "abc123", + "company_id": "4", + "customer_id": 4, + "job_title": "xyz789", "status": "ACTIVE", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -4363,8 +4318,8 @@ Contains details about the address where the company is registered to conduct bu "country_code": "AF", "postcode": "abc123", "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -4389,12 +4344,12 @@ Defines the input schema for defining a company's legal address. ```json { - "city": "xyz789", + "city": "abc123", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -4421,9 +4376,9 @@ Defines the input schema for updating a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "abc123" } ``` @@ -4450,7 +4405,7 @@ Contails details about a single role. "id": "4", "name": "abc123", "permissions": [CompanyAclResource], - "users_count": 123 + "users_count": 987 } ``` @@ -4471,8 +4426,8 @@ Defines the input schema for creating a company role. ```json { - "name": "abc123", - "permissions": ["abc123"] + "name": "xyz789", + "permissions": ["xyz789"] } ``` @@ -4494,9 +4449,9 @@ Defines the input schema for updating a company role. ```json { - "id": "4", - "name": "xyz789", - "permissions": ["xyz789"] + "id": 4, + "name": "abc123", + "permissions": ["abc123"] } ``` @@ -4624,7 +4579,7 @@ Defines an individual node in the company structure. { "entity": CompanyTeam, "id": "4", - "parent_id": 4 + "parent_id": "4" } ``` @@ -4644,10 +4599,7 @@ Defines the input schema for updating the company structure. #### Example ```json -{ - "parent_tree_id": "4", - "tree_id": "4" -} +{"parent_tree_id": "4", "tree_id": 4} ``` @@ -4670,9 +4622,9 @@ Describes a company team. ```json { "description": "abc123", - "id": 4, - "name": "abc123", - "structure_id": "4" + "id": "4", + "name": "xyz789", + "structure_id": 4 } ``` @@ -4718,8 +4670,8 @@ Defines the input schema for updating a company team. ```json { - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "name": "xyz789" } ``` @@ -4745,7 +4697,7 @@ Defines the input schema for updating a company. ```json { - "company_email": "xyz789", + "company_email": "abc123", "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "abc123", @@ -4780,8 +4732,8 @@ Defines the input schema for creating a company user. "email": "abc123", "firstname": "abc123", "job_title": "abc123", - "lastname": "xyz789", - "role_id": "4", + "lastname": "abc123", + "role_id": 4, "status": "ACTIVE", "target_id": 4, "telephone": "xyz789" @@ -4831,13 +4783,13 @@ Defines the input schema for updating a company user. ```json { "email": "abc123", - "firstname": "abc123", - "id": "4", + "firstname": "xyz789", + "id": 4, "job_title": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "role_id": "4", "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -4901,7 +4853,7 @@ Contains an attribute code that is used for product comparisons. ```json { "code": "xyz789", - "label": "xyz789" + "label": "abc123" } ``` @@ -4951,7 +4903,7 @@ Contains iterable information such as the array of items, the count, and attribu "attributes": [ComparableAttribute], "item_count": 123, "items": [ComparableItem], - "uid": "4" + "uid": 4 } ``` @@ -5009,7 +4961,6 @@ Represents all product types, except simple products. Complex product prices are | `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | | `urlKey` - [`String`](#string) | The URL key of the product. | | `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. Links are used to navigate from one product to another. | -| `categories` - [`[CategoryProductView!]`](#categoryproductview) | A list of categories in which the product is present. | | `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | | `visibility` - [`String`](#string) | Visibility setting of the product | @@ -5018,29 +4969,28 @@ Represents all product types, except simple products. Complex product prices are ```json { "addToCartAllowed": true, - "inStock": false, - "lowStock": true, + "inStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", + "description": "xyz789", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", + "metaDescription": "abc123", + "metaKeyword": "abc123", "metaTitle": "xyz789", "name": "xyz789", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, "shortDescription": "xyz789", - "sku": "xyz789", + "sku": "abc123", "externalId": "abc123", - "url": "abc123", - "urlKey": "abc123", + "url": "xyz789", + "urlKey": "xyz789", "links": [ProductViewLink], - "categories": [CategoryProductView], - "queryType": "xyz789", + "queryType": "abc123", "visibility": "abc123" } ``` @@ -5058,7 +5008,7 @@ Represents all product types, except simple products. Complex product prices are #### Example ```json -{"html": "xyz789"} +{"html": "abc123"} ``` @@ -5079,7 +5029,7 @@ Represents all product types, except simple products. Complex product prices are { "field": "UNKNOWN_FIELD", "operator": OperatorInput, - "enabled": true + "enabled": false } ``` @@ -5104,8 +5054,8 @@ Contains details about a configurable product attribute option. { "code": "abc123", "label": "xyz789", - "uid": "4", - "value_index": 123 + "uid": 4, + "value_index": 987 } ``` @@ -5120,6 +5070,7 @@ An implementation for configurable product cart items. | Field Name | Description | |------------|-------------| | `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `configurable_options` - [`[SelectedConfigurableOption]!`](#selectedconfigurableoption) | An array containing the configuranle options the shopper selected. | | `configured_variant` - [`ProductInterface!`](#productinterface) | Product details of the cart item. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | @@ -5128,10 +5079,11 @@ An implementation for configurable product cart items. | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | | `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | | `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -5144,6 +5096,7 @@ An implementation for configurable product cart items. ```json { "available_gift_wrapping": [GiftWrapping], + "backorder_message": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -5152,15 +5105,16 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, + "is_salable": false, "max_qty": 123.45, - "min_qty": 123.45, - "not_available_message": "abc123", + "min_qty": 987.65, + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -5183,7 +5137,7 @@ Describes configurable options that have been selected and can be selected as a ```json { "attribute_code": "abc123", - "option_value_uids": [4] + "option_value_uids": ["4"] } ``` @@ -5226,28 +5180,28 @@ Describes configurable options that have been selected and can be selected as a { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, + "quantity_canceled": 123.45, "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 987.65, "quantity_return_requested": 987.65, "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -5310,7 +5264,7 @@ Defines basic features of a configurable product and its simple product variants ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, @@ -5318,40 +5272,40 @@ Defines basic features of a configurable product and its simple product variants "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", + "meta_keyword": "abc123", + "meta_title": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "abc123", "new_to_date": "abc123", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "variants": [ConfigurableVariant], "weight": 987.65 } @@ -5376,9 +5330,9 @@ Contains details about configurable product options. ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "label": "abc123", - "uid": 4, + "uid": "4", "values": [ConfigurableProductOptionValue] } ``` @@ -5404,7 +5358,7 @@ Defines a value for a configurable product option. ```json { "is_available": true, - "is_use_default": true, + "is_use_default": false, "label": "abc123", "swatch": SwatchDataInterface, "uid": "4" @@ -5433,11 +5387,11 @@ Defines configurable attributes for the specified product. ```json { - "attribute_code": "xyz789", - "attribute_uid": 4, - "label": "abc123", - "position": 987, - "uid": "4", + "attribute_code": "abc123", + "attribute_uid": "4", + "label": "xyz789", + "position": 123, + "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -5525,8 +5479,8 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, - "sku": "xyz789", + "quantity": 123.45, + "sku": "abc123", "uid": 4 } ``` @@ -5576,7 +5530,7 @@ A configurable product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], @@ -5625,7 +5579,7 @@ Contains details about a customer email address to confirm. ```json { "confirmation_key": "xyz789", - "email": "abc123" + "email": "xyz789" } ``` @@ -5645,7 +5599,7 @@ Contains details about a customer email address to confirm. ```json { "confirmation_key": "abc123", - "order_id": 4 + "order_id": "4" } ``` @@ -5685,10 +5639,10 @@ List of account confirmation statuses. ```json { - "comment": "abc123", - "email": "xyz789", + "comment": "xyz789", + "email": "abc123", "name": "xyz789", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -5790,11 +5744,11 @@ Contains the source and target wish lists after copying products. ```json { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", + "full_name_english": "abc123", + "full_name_locale": "xyz789", "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } ``` @@ -6147,7 +6101,7 @@ Contains an array of product IDs to use for creating a compare list. #### Example ```json -{"products": [4]} +{"products": ["4"]} ``` @@ -6178,7 +6132,7 @@ Defines a new gift registry. ], "event_name": "abc123", "gift_registry_type_uid": 4, - "message": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -6217,7 +6171,7 @@ Contains the results of a request to create a gift registry. #### Example ```json -{"cart_uid": 4} +{"cart_uid": "4"} ``` @@ -6256,9 +6210,9 @@ Contains payment order details that are used while processing the payment order ```json { - "cartId": "xyz789", + "cartId": "abc123", "location": "PRODUCT_DETAIL", - "methodCode": "abc123", + "methodCode": "xyz789", "paymentSource": "abc123", "vaultIntent": false } @@ -6285,10 +6239,10 @@ Contains payment order details that are used while processing the payment order ```json { "amount": 123.45, - "currency_code": "xyz789", + "currency_code": "abc123", "id": "abc123", "mp_order_id": "abc123", - "status": "xyz789" + "status": "abc123" } ``` @@ -6308,7 +6262,7 @@ Specifies the amount and currency to evaluate. #### Example ```json -{"currency": "AFN", "value": 987.65} +{"currency": "AFN", "value": 123.45} ``` @@ -6354,7 +6308,7 @@ An input object that identifies and describes a new requisition list. ```json { - "description": "abc123", + "description": "xyz789", "name": "xyz789" } ``` @@ -6394,7 +6348,7 @@ Describe the variables needed to create a vault payment token ```json { - "card_description": "xyz789", + "card_description": "abc123", "setup_token_id": "xyz789" } ``` @@ -6417,7 +6371,7 @@ The vault token id and information about the payment source ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } ``` @@ -6521,7 +6475,7 @@ Contains credit memo details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": 4, + "id": "4", "items": [CreditMemoItemInterface], "number": "xyz789", "total": CreditMemoTotal @@ -6545,7 +6499,7 @@ Defines a credit memo item's custom attributes. ```json { - "credit_memo_id": "abc123", + "credit_memo_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -6575,10 +6529,10 @@ Defines a credit memo item's custom attributes. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -6640,12 +6594,12 @@ Credit memo item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -6722,9 +6676,9 @@ Contains credit memo price details. ```json { - "available_currency_codes": ["abc123"], - "base_currency_code": "xyz789", - "base_currency_symbol": "xyz789", + "available_currency_codes": ["xyz789"], + "base_currency_code": "abc123", + "base_currency_symbol": "abc123", "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -6919,6 +6873,25 @@ The list of available currency codes. +### CurrentProductInput + +Attributes of the product currently being viewed on PDP + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `sku` - [`String`](#string) | SKU of the current product | +| `price` - [`Float`](#float) | Resolved display price of the current product (specialPrice ?? regularPrice) | + +#### Example + +```json +{"sku": "xyz789", "price": 123.45} +``` + + + ### CustomAttribute Specifies the custom attribute code and value. @@ -6934,8 +6907,8 @@ Specifies the custom attribute code and value. ```json { - "attribute_code": "xyz789", - "value": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` @@ -6994,8 +6967,8 @@ An interface containing fields that define the EAV attribute. ```json { - "code": "4", - "default_value": "abc123", + "code": 4, + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", @@ -7029,7 +7002,7 @@ An interface containing fields that define the EAV attribute. ```json { "is_default": true, - "label": "xyz789", + "label": "abc123", "value": "abc123" } ``` @@ -7051,8 +7024,8 @@ A simple key value object. ```json { - "key": "abc123", - "value": "abc123" + "key": "xyz789", + "value": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-2.md b/src/pages/includes/autogenerated/graphql-api-saas-types-2.md index 8065ebe4c..747063e1c 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-2.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-2.md @@ -45,8 +45,10 @@ Defines the customer name, addresses, and other details. |------------|-------------| | `addresses` - [`[CustomerAddress]`](#customeraddress) | An array containing the customer's shipping and billing addresses. | | `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | +| `admin_assistance_actions` - [`AdminAssistanceActions!`](#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | | `allow_remote_shopping_assistance` - [`Boolean!`](#boolean) | Indicates whether the customer has enabled remote shopping assistance. | | `companies` - [`UserCompaniesOutput!`](#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | +| `company_hierarchy` - [`[CompanyHierarchy]`](#companyhierarchy) | The company relation hierarchies for all companies. Only available to the company administrator. | | `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | | `confirmation_status` - [`ConfirmationStatusEnum!`](#confirmationstatusenum) | The customer's confirmation status. | | `created_at` - [`String`](#string) | Timestamp indicating when the account was created. | @@ -96,34 +98,36 @@ Defines the customer name, addresses, and other details. { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, - "allow_remote_shopping_assistance": false, + "admin_assistance_actions": AdminAssistanceActions, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, + "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", + "date_of_birth": "abc123", + "default_billing": "abc123", "default_shipping": "xyz789", "email": "xyz789", - "firstname": "xyz789", - "gender": 987, + "firstname": "abc123", + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", - "is_subscribed": true, - "job_title": "abc123", + "is_subscribed": false, + "job_title": "xyz789", "lastname": "abc123", "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, + "purchase_orders_enabled": true, "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, @@ -133,9 +137,9 @@ Defines the customer name, addresses, and other details. "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, - "suffix": "abc123", - "taxvat": "abc123", + "structure_id": "4", + "suffix": "xyz789", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist_v2": Wishlist, @@ -179,27 +183,27 @@ Contains detailed information about a customer's billing or shipping address. ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": true, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], "suffix": "abc123", - "telephone": "abc123", + "telephone": "xyz789", "uid": 4, - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -220,8 +224,8 @@ Specifies the attribute code and value of a customer address attribute. ```json { - "attribute_code": "xyz789", - "value": "abc123" + "attribute_code": "abc123", + "value": "xyz789" } ``` @@ -257,23 +261,23 @@ Contains details about a billing or shipping address. ```json { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInput], "default_billing": true, "default_shipping": true, - "fax": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "abc123", + "fax": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", - "vat_id": "xyz789" + "vat_id": "abc123" } ``` @@ -297,7 +301,7 @@ Defines the customer's state or province. { "region": "xyz789", "region_code": "xyz789", - "region_id": 987 + "region_id": 123 } ``` @@ -319,9 +323,9 @@ Defines the customer's state or province. ```json { - "region": "xyz789", + "region": "abc123", "region_code": "xyz789", - "region_id": 123 + "region_id": 987 } ``` @@ -375,18 +379,18 @@ Customer attribute metadata. ```json { - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": true, - "label": "xyz789", - "multiline_count": 987, + "label": "abc123", + "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -419,17 +423,17 @@ An input object for creating a customer. ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "gender": 987, "is_subscribed": false, "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "password": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "suffix": "abc123", "taxvat": "xyz789" } @@ -455,11 +459,11 @@ Contains details about a single downloadable product. ```json { - "date": "abc123", + "date": "xyz789", "download_url": "abc123", - "order_increment_id": "abc123", - "remaining_downloads": "xyz789", - "status": "abc123" + "order_increment_id": "xyz789", + "remaining_downloads": "abc123", + "status": "xyz789" } ``` @@ -509,6 +513,7 @@ Contains details about each of the customer's orders. | Field Name | Description | |------------|-------------| +| `admin_assisted_order` - [`Int`](#int) | Admin user id when the order was placed with assistance (Login as Customer); null if not assisted. | | `applied_coupons` - [`[AppliedCoupon]!`](#appliedcoupon) | Coupons applied to the order. | | `applied_gift_cards` - [`[ApplyGiftCardToOrder]`](#applygiftcardtoorder) | An array of gift cards applied to the order. | | `available_actions` - [`[OrderActionType]!`](#orderactiontype) | List of available order actions. | @@ -545,6 +550,7 @@ Contains details about each of the customer's orders. ```json { + "admin_assisted_order": 987, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], @@ -554,7 +560,7 @@ Contains details about each of the customer's orders. "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, @@ -565,7 +571,7 @@ Contains details about each of the customer's orders. "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "abc123", - "order_date": "xyz789", + "order_date": "abc123", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, @@ -573,8 +579,8 @@ Contains details about each of the customer's orders. "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "abc123", - "token": "xyz789", + "status": "xyz789", + "token": "abc123", "total": OrderTotal } ``` @@ -636,7 +642,7 @@ The collection of orders that match the conditions defined in the filter. ```json { - "date_of_first_order": "xyz789", + "date_of_first_order": "abc123", "items": [CustomerOrder], "page_info": SearchResultPageInfo, "total_count": 987 @@ -720,7 +726,7 @@ Customer segment details #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -743,7 +749,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -790,7 +796,7 @@ Contains store credit history information. ```json { - "action": "xyz789", + "action": "abc123", "actual_balance": Money, "balance_change": Money, "date_time_changed": "abc123" @@ -841,16 +847,16 @@ An input object for updating a customer. ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", + "date_of_birth": "xyz789", "firstname": "abc123", - "gender": 123, - "is_subscribed": true, - "lastname": "xyz789", + "gender": 987, + "is_subscribed": false, + "lastname": "abc123", "middlename": "xyz789", - "prefix": "abc123", - "suffix": "xyz789", + "prefix": "xyz789", + "suffix": "abc123", "taxvat": "xyz789" } ``` @@ -876,11 +882,11 @@ Contains information about a text area that is defined as part of a customizable ```json { - "product_sku": "xyz789", - "required": false, + "product_sku": "abc123", + "required": true, "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": CustomizableAreaValue } ``` @@ -906,10 +912,10 @@ Defines the price and sku of a product whose page contains a customized text are ```json { "max_characters": 987, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -936,7 +942,7 @@ Contains information about a set of checkbox values that are defined as part of "required": false, "sort_order": 123, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -963,12 +969,12 @@ Defines the price and sku of a product whose page contains a customized set of c ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "sort_order": 123, - "title": "abc123", + "sort_order": 987, + "title": "xyz789", "uid": "4" } ``` @@ -996,7 +1002,7 @@ Contains information about a date picker that is defined as part of a customizab { "product_sku": "xyz789", "required": true, - "sort_order": 987, + "sort_order": 123, "title": "abc123", "uid": "4", "value": CustomizableDateValue @@ -1043,11 +1049,11 @@ Defines the price and sku of a product whose page contains a customized date pic ```json { - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "type": "DATE", - "uid": "4" + "uid": 4 } ``` @@ -1071,7 +1077,7 @@ Contains information about a drop down menu that is defined as part of a customi ```json { - "required": true, + "required": false, "sort_order": 123, "title": "abc123", "uid": 4, @@ -1101,11 +1107,11 @@ Defines the price and sku of a product whose page contains a customized drop dow ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "sort_order": 123, + "sort_order": 987, "title": "abc123", "uid": "4" } @@ -1132,11 +1138,11 @@ Contains information about a text field that is defined as part of a customizabl ```json { - "product_sku": "xyz789", + "product_sku": "abc123", "required": true, - "sort_order": 987, + "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": CustomizableFieldValue } ``` @@ -1161,11 +1167,11 @@ Defines the price and sku of a product whose page contains a customized text fie ```json { - "max_characters": 123, - "price": 123.45, + "max_characters": 987, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", - "uid": 4 + "sku": "abc123", + "uid": "4" } ``` @@ -1190,11 +1196,11 @@ Contains information about a file picker that is defined as part of a customizab ```json { - "product_sku": "abc123", + "product_sku": "xyz789", "required": true, "sort_order": 987, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableFileValue } ``` @@ -1221,10 +1227,10 @@ Defines the price and sku of a product whose page contains a customized file pic ```json { - "file_extension": "xyz789", - "image_size_x": 987, + "file_extension": "abc123", + "image_size_x": 123, "image_size_y": 123, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", "sku": "xyz789", "uid": 4 @@ -1252,9 +1258,9 @@ Contains information about a multiselect that is defined as part of a customizab ```json { "required": false, - "sort_order": 123, - "title": "xyz789", - "uid": "4", + "sort_order": 987, + "title": "abc123", + "uid": 4, "value": [CustomizableMultipleValue] } ``` @@ -1281,7 +1287,7 @@ Defines the price and sku of a product whose page contains a customized multisel ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "abc123", @@ -1307,7 +1313,7 @@ Defines a customizable option. #### Example ```json -{"uid": 4, "value_string": "xyz789"} +{"uid": 4, "value_string": "abc123"} ``` @@ -1345,7 +1351,7 @@ Contains basic information about a customizable option. It can be implemented by "required": true, "sort_order": 987, "title": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1401,7 +1407,7 @@ Contains information about a set of radio buttons that are defined as part of a "required": true, "sort_order": 123, "title": "xyz789", - "uid": "4", + "uid": 4, "value": [CustomizableRadioValue] } ``` @@ -1428,13 +1434,13 @@ Defines the price and sku of a product whose page contains a customized set of r ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 123, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1465,7 +1471,7 @@ Contains the response to the request to delete the company role. #### Example ```json -{"success": false} +{"success": true} ``` @@ -1519,7 +1525,7 @@ Contains the results of the request to delete a compare list. #### Example ```json -{"result": true} +{"result": false} ``` @@ -1558,7 +1564,7 @@ Contains details about a failed delete operation on a negotiable quote. ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -1594,7 +1600,7 @@ Specifies the quote template id of the quote template to delete #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -1610,7 +1616,7 @@ Specifies the quote template id of the quote template to delete #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -1767,7 +1773,7 @@ Indicates whether the request to delete the requisition list was successful. #### Example ```json -{"requisition_lists": RequisitionLists, "status": false} +{"requisition_lists": RequisitionLists, "status": true} ``` @@ -1815,7 +1821,7 @@ Specifies the discount type and value for quote line item. "applied_to": "ITEM", "coupon": AppliedCoupon, "is_discounting_locked": true, - "label": "abc123", + "label": "xyz789", "type": "xyz789", "value": 123.45 } @@ -1831,15 +1837,17 @@ An implementation for downloadable product cart items. | Field Name | Description | |------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `links` - [`[DownloadableProductLinks]`](#downloadableproductlinks) | An array containing information about the links for the downloadable product added to the cart. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -1852,14 +1860,16 @@ An implementation for downloadable product cart items. ```json { + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "is_available": true, + "is_salable": false, "links": [DownloadableProductLinks], - "max_qty": 123.45, - "min_qty": 987.65, + "max_qty": 987.65, + "min_qty": 123.45, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], @@ -1900,9 +1910,9 @@ Defines downloadable product options for `CreditMemoItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_refunded": 987.65 } ``` @@ -1936,9 +1946,9 @@ Defines downloadable product options for `InvoiceItemInterface`. "downloadable_links": [DownloadableItemsLinks], "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 987.65 } ``` @@ -1962,8 +1972,8 @@ Defines characteristics of the links for downloadable product. ```json { "sort_order": 123, - "title": "xyz789", - "uid": "4" + "title": "abc123", + "uid": 4 } ``` @@ -2009,27 +2019,27 @@ Defines downloadable product options for `OrderItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "product_type": "xyz789", - "product_url_key": "xyz789", + "product_sku": "xyz789", + "product_type": "abc123", + "product_url_key": "abc123", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2094,7 +2104,7 @@ Defines a product that the shopper downloads. { "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -2108,26 +2118,26 @@ Defines a product that the shopper downloads. "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", - "links_purchased_separately": 987, - "links_title": "abc123", + "is_returnable": "xyz789", + "links_purchased_separately": 123, + "links_title": "xyz789", "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_description": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "abc123", + "min_sale_qty": 123.45, + "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "new_to_date": "abc123", + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "abc123", @@ -2135,11 +2145,11 @@ Defines a product that the shopper downloads. "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -2190,10 +2200,10 @@ Defines characteristics of a downloadable product. ```json { "price": 123.45, - "sample_url": "xyz789", - "sort_order": 987, - "title": "abc123", - "uid": 4 + "sample_url": "abc123", + "sort_order": 123, + "title": "xyz789", + "uid": "4" } ``` @@ -2233,9 +2243,9 @@ Defines characteristics of a downloadable product. ```json { - "sample_url": "abc123", + "sample_url": "xyz789", "sort_order": 987, - "title": "abc123" + "title": "xyz789" } ``` @@ -2266,7 +2276,7 @@ Contains details about downloadable products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "samples": [DownloadableProductSamples], - "sku": "abc123", + "sku": "xyz789", "uid": 4 } ``` @@ -2294,13 +2304,13 @@ A downloadable product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples] } ``` @@ -2321,7 +2331,10 @@ Identifies a quote to be duplicated #### Example ```json -{"duplicated_quote_uid": 4, "quote_uid": 4} +{ + "duplicated_quote_uid": 4, + "quote_uid": "4" +} ``` @@ -2359,8 +2372,8 @@ Contains details about a custom text attribute that the buyer entered. ```json { - "attribute_code": "abc123", - "value": "xyz789" + "attribute_code": "xyz789", + "value": "abc123" } ``` @@ -2408,7 +2421,7 @@ An error encountered while adding an item to the the cart. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -2455,7 +2468,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -2536,7 +2549,7 @@ Contains customer token for external customer. ```json { "customer": Customer, - "token": "abc123" + "token": "xyz789" } ``` @@ -2583,11 +2596,11 @@ Lists the exchange rate. "code": "abc123", "is_visible": true, "payment_intent": "xyz789", - "payment_source": "xyz789", + "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "xyz789" + "title": "abc123" } ``` @@ -2609,7 +2622,7 @@ Fastlane Payment inputs ```json { "payment_source": "abc123", - "paypal_fastlane_token": "abc123" + "paypal_fastlane_token": "xyz789" } ``` @@ -2691,7 +2704,7 @@ Defines a filter that performs a fuzzy search. #### Example ```json -{"match": "xyz789", "match_type": "FULL"} +{"match": "abc123", "match_type": "FULL"} ``` @@ -2711,7 +2724,7 @@ Defines a filter that matches a range of values, such as prices or dates. ```json { - "from": "abc123", + "from": "xyz789", "to": "abc123" } ``` @@ -2732,7 +2745,7 @@ Defines a filter that matches a range of values, such as prices or dates. ```json { - "name": "xyz789", + "name": "abc123", "type": "UNKNOWN_FILTER_RULE_TYPE", "conditions": [ConditionInput] } @@ -2774,9 +2787,9 @@ Defines a filter for an input string. ```json { - "eq": "abc123", + "eq": "xyz789", "in": ["xyz789"], - "match": "xyz789" + "match": "abc123" } ``` @@ -2811,18 +2824,18 @@ Defines the comparison operators that can be used in a filter. { "eq": "abc123", "from": "abc123", - "gt": "xyz789", + "gt": "abc123", "gteq": "xyz789", "in": ["xyz789"], - "like": "abc123", + "like": "xyz789", "lt": "xyz789", "lteq": "xyz789", - "moreq": "xyz789", - "neq": "abc123", + "moreq": "abc123", + "neq": "xyz789", "nin": ["xyz789"], "notnull": "abc123", - "null": "abc123", - "to": "abc123" + "null": "xyz789", + "to": "xyz789" } ``` @@ -2845,10 +2858,10 @@ Contains product attributes that can be used for filtering in a `productSearch` ```json { - "attribute": "abc123", + "attribute": "xyz789", "frontendInput": "abc123", "label": "abc123", - "numeric": true + "numeric": false } ``` @@ -2941,7 +2954,7 @@ Contains the generated customer token. #### Example ```json -{"customer_token": "xyz789"} +{"customer_token": "abc123"} ``` @@ -2959,7 +2972,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -3017,8 +3030,8 @@ Contains details about the gift card account. ```json { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } ``` @@ -3037,7 +3050,7 @@ Contains the gift card code. #### Example ```json -{"gift_card_code": "xyz789"} +{"gift_card_code": "abc123"} ``` @@ -3060,9 +3073,9 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 987, + "attribute_id": 123, "uid": 4, - "value": 987.65, + "value": 123.45, "website_id": 123, "website_value": 987.65 } @@ -3080,17 +3093,19 @@ Contains details about a gift card that has been added to a cart. |------------|-------------| | `amount` - [`Money!`](#money) | The amount and currency of the gift card. | | `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array of customizations applied to the gift card. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | | `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message data for the gift card cart item | | `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping option for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `message` - [`String`](#string) | The message from the sender to the recipient. | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -3108,6 +3123,7 @@ Contains details about a gift card that has been added to a cart. { "amount": Money, "available_gift_wrapping": [GiftWrapping], + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -3115,19 +3131,20 @@ Contains details about a gift card that has been added to a cart. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": true, - "max_qty": 123.45, + "is_salable": false, + "max_qty": 987.65, "message": "xyz789", "min_qty": 987.65, - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "recipient_email": "xyz789", + "recipient_email": "abc123", "recipient_name": "abc123", - "sender_email": "xyz789", - "sender_name": "xyz789", + "sender_email": "abc123", + "sender_name": "abc123", "uid": "4" } ``` @@ -3157,11 +3174,11 @@ Contains details about a gift card that has been added to a cart. "custom_attributes": [CustomAttribute], "discounts": [Discount], "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_refunded": 987.65 } ``` @@ -3193,10 +3210,10 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 + "product_sku": "xyz789", + "quantity_invoiced": 987.65 } ``` @@ -3220,11 +3237,11 @@ Contains details about a gift card. ```json { - "message": "abc123", - "recipient_email": "abc123", - "recipient_name": "xyz789", + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -3252,11 +3269,11 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "xyz789", + "message": "abc123", "recipient_email": "xyz789", "recipient_name": "abc123", "sender_email": "xyz789", - "sender_name": "xyz789" + "sender_name": "abc123" } ``` @@ -3304,18 +3321,18 @@ Contains details about the sender, recipient, and amount of a gift card. "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, + "quantity_invoiced": 123.45, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, "quantity_returned": 123.45, "quantity_shipped": 987.65, @@ -3390,8 +3407,8 @@ Defines properties of a gift card. ```json { - "allow_message": false, - "allow_open_amount": true, + "allow_message": true, + "allow_open_amount": false, "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "xyz789", @@ -3405,39 +3422,39 @@ Defines properties of a gift card. "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "image": ProductImage, - "is_redeemable": false, + "is_redeemable": true, "is_returnable": "xyz789", - "lifetime": 123, + "lifetime": 987, "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "message_max_length": 987, - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 123.45, "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, - "open_amount_max": 987.65, - "open_amount_min": 987.65, + "open_amount_max": 123.45, + "open_amount_min": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123", "weight": 987.65 @@ -3468,9 +3485,9 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -3497,10 +3514,10 @@ Contains details about gift cards added to a requisition list. "gift_card": GiftCardItem, "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -3546,13 +3563,13 @@ A single gift card added to a wish list. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "gift_card_options": GiftCardOptions, - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3575,7 +3592,7 @@ Contains the text of a gift message, its sender, and recipient ```json { "from": "xyz789", - "message": "xyz789", + "message": "abc123", "to": "xyz789" } ``` @@ -3598,7 +3615,7 @@ Defines a gift message. ```json { - "from": "xyz789", + "from": "abc123", "message": "abc123", "to": "abc123" } @@ -3672,7 +3689,7 @@ Contains details about a gift registry. "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": 4 + "uid": "4" } ``` @@ -3693,10 +3710,10 @@ Contains details about a gift registry. ```json { - "code": 4, + "code": "4", "group": "EVENT_INFORMATION", "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3739,10 +3756,7 @@ Defines a dynamic attribute. #### Example ```json -{ - "code": "4", - "value": "abc123" -} +{"code": 4, "value": "xyz789"} ``` @@ -3770,7 +3784,7 @@ Defines a dynamic attribute. { "code": 4, "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -3794,8 +3808,8 @@ Defines a dynamic attribute. ```json { "attribute_group": "xyz789", - "code": "4", - "input_type": "abc123", + "code": 4, + "input_type": "xyz789", "is_required": true, "label": "abc123", "sort_order": 123 @@ -3827,12 +3841,12 @@ Defines a dynamic attribute. ```json { - "attribute_group": "abc123", - "code": "4", + "attribute_group": "xyz789", + "code": 4, "input_type": "abc123", "is_required": true, - "label": "abc123", - "sort_order": 987 + "label": "xyz789", + "sort_order": 123 } ``` @@ -3855,11 +3869,11 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", + "created_at": "xyz789", "note": "abc123", "product": ProductInterface, "quantity": 123.45, - "quantity_fulfilled": 987.65, + "quantity_fulfilled": 123.45, "uid": "4" } ``` @@ -3893,8 +3907,8 @@ Defines a dynamic attribute. "note": "xyz789", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 987.65, - "uid": "4" + "quantity_fulfilled": 123.45, + "uid": 4 } ``` @@ -3921,7 +3935,7 @@ Contains the status and any errors that encountered with the customer's gift reg ```json { - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -3948,8 +3962,8 @@ Contains details about an error that occurred when processing a gift registry it { "code": "OUT_OF_STOCK", "gift_registry_item_uid": 4, - "gift_registry_uid": "4", - "message": "abc123", + "gift_registry_uid": 4, + "message": "xyz789", "product_uid": "4" } ``` @@ -4040,10 +4054,10 @@ Contains details about a registrant. "dynamic_attributes": [ GiftRegistryRegistrantDynamicAttribute ], - "email": "xyz789", + "email": "abc123", "firstname": "abc123", "lastname": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -4065,7 +4079,7 @@ Contains details about a registrant. { "code": 4, "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -4090,7 +4104,7 @@ Contains the results of a gift registry search. ```json { - "event_date": "xyz789", + "event_date": "abc123", "event_title": "abc123", "gift_registry_uid": 4, "location": "abc123", @@ -4119,7 +4133,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or { "address_data": CustomerAddressInput, "address_id": 4, - "customer_address_uid": 4 + "customer_address_uid": "4" } ``` @@ -4187,10 +4201,10 @@ Contains details about the selected or available gift wrapping options. ```json { - "design": "abc123", + "design": "xyz789", "image": GiftWrappingImage, "price": Money, - "uid": 4 + "uid": "4" } ``` @@ -4211,8 +4225,8 @@ Points to an image associated with a gift wrapping option. ```json { - "label": "abc123", - "url": "xyz789" + "label": "xyz789", + "url": "abc123" } ``` @@ -4232,8 +4246,8 @@ Points to an image associated with a gift wrapping option. ```json { - "color": "abc123", - "height": 987, + "color": "xyz789", + "height": 123, "type": "xyz789" } ``` @@ -4261,14 +4275,14 @@ Points to an image associated with a gift wrapping option. ```json { "button_styles": GooglePayButtonStyles, - "code": "abc123", - "is_visible": false, - "payment_intent": "xyz789", - "payment_source": "xyz789", + "code": "xyz789", + "is_visible": true, + "payment_intent": "abc123", + "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -4290,9 +4304,9 @@ Google Pay inputs ```json { - "payment_source": "abc123", + "payment_source": "xyz789", "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -4352,30 +4366,30 @@ Defines a grouped product, which consists of simple standalone products that are ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "items": [GroupedProductItem], "manufacturer": 123, - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "xyz789", + "min_sale_qty": 123.45, + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "abc123", "only_x_left_in_stock": 123.45, - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], @@ -4387,9 +4401,9 @@ Defines a grouped product, which consists of simple standalone products that are "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], "url_key": "xyz789", "weight": 987.65 @@ -4441,10 +4455,10 @@ A grouped product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", - "id": "4", + "description": "abc123", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -4491,7 +4505,7 @@ Input to retrieve an order based on details. ```json { "email": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "number": "abc123" } ``` @@ -4541,11 +4555,11 @@ Item note data that is added to the negotiable quote history object. ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_name": "abc123", - "creator_type": "xyz789", - "item_id": 987, - "note": "abc123", + "creator_type": "abc123", + "item_id": 123, + "note": "xyz789", "product_name": "xyz789" } ``` @@ -4574,17 +4588,17 @@ Item note data that is added to the negotiable quote history object. ```json { - "cc_vault_code": "abc123", - "code": "xyz789", + "cc_vault_code": "xyz789", + "code": "abc123", "is_vault_enabled": false, - "is_visible": true, + "is_visible": false, "payment_intent": "abc123", - "payment_source": "abc123", - "requires_card_details": true, + "payment_source": "xyz789", + "requires_card_details": false, "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -4612,15 +4626,15 @@ Hosted Fields payment inputs ```json { - "cardBin": "abc123", - "cardExpiryMonth": "abc123", + "cardBin": "xyz789", + "cardExpiryMonth": "xyz789", "cardExpiryYear": "xyz789", - "cardLast4": "xyz789", - "holderName": "xyz789", + "cardLast4": "abc123", + "holderName": "abc123", "is_active_payment_token_enabler": true, "payment_source": "abc123", "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "paypal_order_id": "abc123" } ``` @@ -4651,13 +4665,35 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob ```json { - "thumbnail": "abc123", + "thumbnail": "xyz789", "value": "xyz789" } ``` +### ImportSharedRequisitionListOutput + +Result of importing a shared requisition list. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList`](#requisitionlist) | The imported requisition list for the current customer. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Validation or import issues. | + +#### Example + +```json +{ + "requisition_list": RequisitionList, + "user_errors": [ShareRequisitionListUserError] +} +``` + + + ### InputFilterEnum List of templates/filters applied to customer attribute input. @@ -4695,7 +4731,7 @@ List of templates/filters applied to customer attribute input. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123", + "message": "xyz789", "quantity": 987.65 } ``` @@ -4709,7 +4745,7 @@ The `Int` scalar type represents non-fractional signed whole numeric values. Int #### Example ```json -987 +123 ``` @@ -4755,7 +4791,7 @@ Contains invoice details. "custom_attributes": [CustomAttribute], "id": 4, "items": [InvoiceItemInterface], - "number": "xyz789", + "number": "abc123", "total": InvoiceTotal } ``` @@ -4805,7 +4841,7 @@ Defines an invoice custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -4833,8 +4869,8 @@ Defines an invoice item custom attributes. ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789", - "invoice_item_id": "xyz789" + "invoice_id": "abc123", + "invoice_item_id": "abc123" } ``` @@ -4872,11 +4908,11 @@ Contains detailes about invoiced items. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 123.45 } ``` @@ -4948,7 +4984,7 @@ Contains the response of a company admin email validation query. #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -4966,7 +5002,7 @@ Contains the response of a company email validation query. #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -4984,7 +5020,7 @@ Contains the response of a role name validation query. #### Example ```json -{"is_role_name_available": true} +{"is_role_name_available": false} ``` @@ -5002,7 +5038,7 @@ Contains the response of a company user email validation query. #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -5020,7 +5056,7 @@ Contains the result of the `isEmailAvailable` query. #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -5037,7 +5073,7 @@ Contains the result of the `isEmailAvailable` query. #### Example ```json -{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true} +{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": false} ``` @@ -5096,10 +5132,10 @@ The note object for quote line item. ```json { - "created_at": "xyz789", + "created_at": "abc123", "creator_id": 987, - "creator_name": "abc123", - "creator_type": 123, + "creator_name": "xyz789", + "creator_type": 987, "negotiable_quote_item_uid": 4, "note": "abc123", "note_uid": 4 @@ -5124,8 +5160,8 @@ A list of options of the selected bundle product. ```json { - "label": "abc123", - "uid": 4, + "label": "xyz789", + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -5151,9 +5187,9 @@ A list of values for the selected bundle product. ```json { "price": Money, - "product_name": "abc123", - "product_sku": "abc123", - "quantity": 123.45, + "product_name": "xyz789", + "product_sku": "xyz789", + "quantity": 987.65, "uid": "4" } ``` @@ -5187,7 +5223,7 @@ Contains a key-value pair. ```json { - "name": "abc123", + "name": "xyz789", "value": "abc123" } ``` @@ -5210,8 +5246,8 @@ Sets quote item note. ```json { - "note": "xyz789", - "quote_item_uid": 4, + "note": "abc123", + "quote_item_uid": "4", "quote_uid": "4" } ``` @@ -5244,7 +5280,7 @@ Contains basic information about a product image or video. ```json { - "disabled": false, + "disabled": true, "label": "xyz789", "position": 123, "url": "abc123" @@ -5286,7 +5322,7 @@ Enumeration of media resource types #### Example ```json -{"type": "xyz789"} +{"type": "abc123"} ``` @@ -5304,7 +5340,7 @@ Enumeration of media resource types ```json { - "layout": "abc123", + "layout": "xyz789", "logo": MessageStyleLogo } ``` @@ -5325,7 +5361,7 @@ Defines a monetary value, including a numeric value and a currency code. #### Example ```json -{"currency": "AFN", "value": 987.65} +{"currency": "AFN", "value": 123.45} ``` @@ -5367,7 +5403,7 @@ An input object that defines the items in a requisition list to be moved. #### Example ```json -{"requisitionListItemUids": ["4"]} +{"requisitionListItemUids": [4]} ``` @@ -5410,8 +5446,8 @@ Move Line Item to Requisition List. ```json { - "quote_item_uid": 4, - "quote_uid": 4, + "quote_item_uid": "4", + "quote_uid": "4", "requisition_list_uid": "4" } ``` @@ -5503,7 +5539,7 @@ Contains details about a negotiable quote. "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], @@ -5514,9 +5550,9 @@ Contains details about a negotiable quote. "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", - "template_id": "4", + "template_id": 4, "template_name": "abc123", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": "4", "updated_at": "abc123" } @@ -5539,7 +5575,7 @@ Defines the company's country. ```json { - "code": "xyz789", + "code": "abc123", "label": "abc123" } ``` @@ -5578,21 +5614,21 @@ Defines the billing or shipping address to be applied to the cart. { "city": "xyz789", "company": "xyz789", - "country_code": "xyz789", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", "middlename": "abc123", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": "xyz789", "region_id": 123, - "save_in_address_book": true, + "save_in_address_book": false, "street": ["abc123"], "suffix": "abc123", "telephone": "xyz789", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -5633,23 +5669,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "xyz789", - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "customer_address_uid": 4, + "fax": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, "street": ["abc123"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "uid": 4, + "vat_id": "xyz789" } ``` @@ -5672,8 +5708,8 @@ Defines the company's state or province. ```json { "code": "abc123", - "label": "xyz789", - "region_id": 987 + "label": "abc123", + "region_id": 123 } ``` @@ -5708,22 +5744,22 @@ Defines the company's state or province. ```json { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "abc123", - "firstname": "abc123", - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "abc123", + "customer_address_uid": "4", + "fax": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "xyz789", + "telephone": "abc123", "uid": "4", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -5747,9 +5783,9 @@ Defines the billing address. ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "same_as_shipping": true, - "use_for_shipping": false + "customer_address_uid": 4, + "same_as_shipping": false, + "use_for_shipping": true } ``` @@ -5776,7 +5812,7 @@ Contains a single plain text comment from either the buyer or seller. { "attachments": [NegotiableQuoteCommentAttachment], "author": NegotiableQuoteUser, - "created_at": "xyz789", + "created_at": "abc123", "creator_type": "BUYER", "text": "xyz789", "uid": "4" @@ -5801,7 +5837,7 @@ Negotiable quote comment file attachment. ```json { "name": "abc123", - "url": "xyz789" + "url": "abc123" } ``` @@ -5858,7 +5894,7 @@ Contains the commend provided by the buyer. ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "xyz789" + "comment": "abc123" } ``` @@ -5880,8 +5916,8 @@ Contains custom log entries added by third-party extensions. ```json { - "new_value": "xyz789", - "old_value": "xyz789", + "new_value": "abc123", + "old_value": "abc123", "title": "abc123" } ``` @@ -5980,7 +6016,7 @@ Contains details about a change for a negotiable quote. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "item_note": HistoryItemNoteData, "uid": 4 } @@ -6023,7 +6059,7 @@ Contains a new expiration date and the previous date. ```json { "new_expiration": "abc123", - "old_expiration": "xyz789" + "old_expiration": "abc123" } ``` @@ -6044,7 +6080,7 @@ Contains lists of products that have been removed from the catalog and negotiabl ```json { - "products_removed_from_catalog": ["4"], + "products_removed_from_catalog": [4], "products_removed_from_quote": [ProductInterface] } ``` @@ -6186,10 +6222,10 @@ Contains a reference document link for a negotiable quote template. ```json { - "document_identifier": "xyz789", - "document_name": "abc123", - "link_id": 4, - "reference_document_url": "abc123" + "document_identifier": "abc123", + "document_name": "xyz789", + "link_id": "4", + "reference_document_url": "xyz789" } ``` @@ -6226,13 +6262,13 @@ Contains a reference document link for a negotiable quote template. ```json { "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", + "customer_address_uid": 4, "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123", "middlename": "abc123", "postcode": "abc123", @@ -6241,9 +6277,9 @@ Contains a reference document link for a negotiable quote template. "selected_shipping_method": SelectedShippingMethod, "street": ["abc123"], "suffix": "abc123", - "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" + "telephone": "abc123", + "uid": 4, + "vat_id": "xyz789" } ``` @@ -6266,8 +6302,8 @@ Defines shipping addresses for the negotiable quote. ```json { "address": NegotiableQuoteAddressInput, - "customer_address_uid": "4", - "customer_notes": "abc123" + "customer_address_uid": 4, + "customer_notes": "xyz789" } ``` @@ -6372,27 +6408,27 @@ Contains details about a negotiable quote template. "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, + "max_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "xyz789", "template_id": 4, "total_quantity": 123.45, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -6419,91 +6455,3 @@ Defines a filter to limit the negotiable quotes to return. ``` - -### NegotiableQuoteTemplateGridItem - -Contains data for a negotiable quote template in a grid. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | -| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | -| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | -| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | -| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | -| `last_ordered_at` - [`String!`](#string) | Timestamp indicating when the last negotiable quote template order was placed. | -| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | -| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | -| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | -| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | -| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | -| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | -| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | -| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | -| `state` - [`String!`](#string) | State of the negotiable quote template. | -| `status` - [`String!`](#string) | The status of the negotiable quote template. | -| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | -| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | -| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | - -#### Example - -```json -{ - "activated_at": "xyz789", - "company_name": "abc123", - "created_at": "abc123", - "expiration_date": "abc123", - "is_min_max_qty_used": true, - "last_ordered_at": "xyz789", - "last_shared_at": "abc123", - "max_order_commitment": 987, - "min_negotiated_grand_total": 987.65, - "min_order_commitment": 123, - "name": "xyz789", - "orders_placed": 123, - "prices": CartPrices, - "sales_rep_name": "xyz789", - "state": "abc123", - "status": "abc123", - "submitted_by": "abc123", - "template_id": 4, - "uid": 4, - "updated_at": "abc123" -} -``` - - - -### NegotiableQuoteTemplateHistoryChanges - -Contains a list of changes to a negotiable quote template. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | -| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | -| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | -| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | -| `statuses` - [`NegotiableQuoteTemplateHistoryStatusesChange`](#negotiablequotetemplatehistorystatuseschange) | The status before and after a change in the negotiable quote template history. | -| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | - -#### Example - -```json -{ - "comment_added": NegotiableQuoteHistoryCommentChange, - "custom_changes": NegotiableQuoteCustomLogChange, - "expiration": NegotiableQuoteHistoryExpirationChange, - "products_removed": NegotiableQuoteHistoryProductsRemovedChange, - "statuses": NegotiableQuoteTemplateHistoryStatusesChange, - "total": NegotiableQuoteHistoryTotalChange -} -``` - - diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-3.md b/src/pages/includes/autogenerated/graphql-api-saas-types-3.md index b03817516..af9ce26c7 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-3.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-3.md @@ -1,3 +1,91 @@ +### NegotiableQuoteTemplateGridItem + +Contains data for a negotiable quote template in a grid. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `activated_at` - [`String!`](#string) | The date and time the negotiable quote template was activated. | +| `company_name` - [`String!`](#string) | Company name the quote template is assigned to | +| `created_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was created. | +| `expiration_date` - [`String!`](#string) | The expiration period of the negotiable quote template. | +| `is_min_max_qty_used` - [`Boolean!`](#boolean) | Indicates whether the minimum and maximum quantity settings are used. | +| `last_ordered_at` - [`String!`](#string) | Timestamp indicating when the last negotiable quote template order was placed. | +| `last_shared_at` - [`String!`](#string) | The date and time the negotiable quote template was last shared. | +| `max_order_commitment` - [`Int!`](#int) | Commitment for maximum orders | +| `min_negotiated_grand_total` - [`Float!`](#float) | The minimum negotiated grand total of the negotiable quote template. | +| `min_order_commitment` - [`Int!`](#int) | Commitment for minimum orders | +| `name` - [`String!`](#string) | The title assigned to the negotiable quote template. | +| `orders_placed` - [`Int!`](#int) | The number of orders placed for the negotiable quote template. | +| `prices` - [`CartPrices`](#cartprices) | A set of subtotals and totals applied to the negotiable quote template. | +| `sales_rep_name` - [`String!`](#string) | The first and last name of the sales representative. | +| `state` - [`String!`](#string) | State of the negotiable quote template. | +| `status` - [`String!`](#string) | The status of the negotiable quote template. | +| `submitted_by` - [`String!`](#string) | The first and last name of the buyer. | +| `template_id` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `uid` - [`ID!`](#id) | The unique ID of a `NegotiableQuoteTemplate` object. | +| `updated_at` - [`String!`](#string) | Timestamp indicating when the negotiable quote template was updated. | + +#### Example + +```json +{ + "activated_at": "abc123", + "company_name": "xyz789", + "created_at": "xyz789", + "expiration_date": "xyz789", + "is_min_max_qty_used": false, + "last_ordered_at": "xyz789", + "last_shared_at": "abc123", + "max_order_commitment": 123, + "min_negotiated_grand_total": 987.65, + "min_order_commitment": 987, + "name": "abc123", + "orders_placed": 987, + "prices": CartPrices, + "sales_rep_name": "abc123", + "state": "abc123", + "status": "xyz789", + "submitted_by": "xyz789", + "template_id": "4", + "uid": "4", + "updated_at": "abc123" +} +``` + + + +### NegotiableQuoteTemplateHistoryChanges + +Contains a list of changes to a negotiable quote template. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `comment_added` - [`NegotiableQuoteHistoryCommentChange`](#negotiablequotehistorycommentchange) | The comment provided with a change in the negotiable quote history. | +| `custom_changes` - [`NegotiableQuoteCustomLogChange`](#negotiablequotecustomlogchange) | Lists log entries added by third-party extensions. | +| `expiration` - [`NegotiableQuoteHistoryExpirationChange`](#negotiablequotehistoryexpirationchange) | The expiration date of the negotiable quote before and after a change in the quote history. | +| `products_removed` - [`NegotiableQuoteHistoryProductsRemovedChange`](#negotiablequotehistoryproductsremovedchange) | Lists products that were removed as a result of a change in the quote history. | +| `statuses` - [`NegotiableQuoteTemplateHistoryStatusesChange`](#negotiablequotetemplatehistorystatuseschange) | The status before and after a change in the negotiable quote template history. | +| `total` - [`NegotiableQuoteHistoryTotalChange`](#negotiablequotehistorytotalchange) | The total amount of the negotiable quote before and after a change in the quote history. | + +#### Example + +```json +{ + "comment_added": NegotiableQuoteHistoryCommentChange, + "custom_changes": NegotiableQuoteCustomLogChange, + "expiration": NegotiableQuoteHistoryExpirationChange, + "products_removed": NegotiableQuoteHistoryProductsRemovedChange, + "statuses": NegotiableQuoteTemplateHistoryStatusesChange, + "total": NegotiableQuoteHistoryTotalChange +} +``` + + + ### NegotiableQuoteTemplateHistoryEntry Contains details about a change for a negotiable quote template. @@ -19,7 +107,7 @@ Contains details about a change for a negotiable quote template. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteTemplateHistoryChanges, - "created_at": "abc123", + "created_at": "xyz789", "uid": "4" } ``` @@ -41,8 +129,8 @@ Lists a new status change applied to a negotiable quote template and the previou ```json { - "new_status": "xyz789", - "old_status": "xyz789" + "new_status": "abc123", + "old_status": "abc123" } ``` @@ -82,12 +170,7 @@ Specifies the updated quantity of an item. #### Example ```json -{ - "item_id": "4", - "max_qty": 987.65, - "min_qty": 987.65, - "quantity": 123.45 -} +{"item_id": 4, "max_qty": 987.65, "min_qty": 123.45, "quantity": 123.45} ``` @@ -110,7 +193,7 @@ Defines the reference document link to add to a negotiable quote template. ```json { "document_identifier": "abc123", - "document_name": "xyz789", + "document_name": "abc123", "link_id": 4, "reference_document_url": "abc123" } @@ -136,7 +219,7 @@ Defines shipping addresses for the negotiable quote template. { "address": NegotiableQuoteAddressInput, "customer_address_uid": 4, - "customer_notes": "abc123" + "customer_notes": "xyz789" } ``` @@ -221,7 +304,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": "4"} +{"quote_uid": 4} ``` @@ -239,7 +322,7 @@ Contains details about a successful operation on a negotiable quote. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -259,8 +342,8 @@ A limited view of a Buyer or Seller in the negotiable quote process. ```json { - "firstname": "xyz789", - "lastname": "xyz789" + "firstname": "abc123", + "lastname": "abc123" } ``` @@ -306,10 +389,7 @@ Contains an error message when an invalid UID was specified. #### Example ```json -{ - "message": "xyz789", - "uid": "4" -} +{"message": "abc123", "uid": 4} ``` @@ -361,7 +441,7 @@ Contains an error message when an invalid UID was specified. ```json { - "backend_integration_url": "abc123", + "backend_integration_url": "xyz789", "custom_config": [CustomConfigKeyValue] } ``` @@ -381,7 +461,7 @@ Specifies the quote template id to open quote template. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -479,22 +559,22 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "lastname": "abc123", "middlename": "abc123", "postcode": "xyz789", - "prefix": "abc123", - "region": "xyz789", - "region_id": "4", - "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "abc123" + "prefix": "xyz789", + "region": "abc123", + "region_id": 4, + "street": ["xyz789"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "xyz789" } ``` @@ -516,10 +596,10 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "firstname": "abc123", - "lastname": "abc123", - "middlename": "xyz789", - "prefix": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", + "prefix": "xyz789", "suffix": "abc123" } ``` @@ -569,18 +649,18 @@ Contains detailed information about an order's billing and shipping addresses. "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, - "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_return_requested": 123.45, + "quantity_returned": 987.65, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -640,23 +720,23 @@ Order item details. "entered_options": [OrderItemOption], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "quantity_invoiced": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -767,7 +847,7 @@ Contains order shipment details. "comments": [SalesCommentItem], "id": 4, "items": [ShipmentItemInterface], - "number": "abc123", + "number": "xyz789", "tracking": [ShipmentTracking] } ``` @@ -787,7 +867,7 @@ Input to retrieve an order based on token. #### Example ```json -{"token": "abc123"} +{"token": "xyz789"} ``` @@ -838,26 +918,6 @@ Contains details about the sales total amounts used to calculate the final price -### PageInfo - -Provides pagination information for navigating through paginated result sets. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `currentPage` - [`Int!`](#int) | The current page number (1-based indexing). | -| `pageSize` - [`Int!`](#int) | The number of items per page. | -| `totalPages` - [`Int!`](#int) | The total number of pages available. | - -#### Example - -```json -{"currentPage": 987, "pageSize": 987, "totalPages": 123} -``` - - - ### PageType Type of page on which recommendations are requested @@ -896,7 +956,7 @@ Defines the payment attribute. ```json { - "key": "xyz789", + "key": "abc123", "value": "abc123" } ``` @@ -934,9 +994,9 @@ Contains payment fields that are common to all types of payment methods. { "code": "abc123", "is_visible": true, - "payment_intent": "xyz789", + "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "abc123" } ``` @@ -1016,14 +1076,14 @@ Defines the payment method. ```json { "additional_data": [PaymentAttributeInput], - "code": "xyz789", + "code": "abc123", "payment_services_paypal_apple_pay": ApplePayMethodInput, "payment_services_paypal_fastlane": FastlaneMethodInput, "payment_services_paypal_google_pay": GooglePayMethodInput, "payment_services_paypal_hosted_fields": HostedFieldsInput, "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, - "purchase_order_number": "xyz789" + "purchase_order_number": "abc123" } ``` @@ -1046,10 +1106,10 @@ Contains the payment order details ```json { - "id": "abc123", + "id": "xyz789", "mp_order_id": "abc123", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } ``` @@ -1068,7 +1128,7 @@ Contains the payment order details ```json { - "code": "xyz789", + "code": "abc123", "params": [SDKParams] } ``` @@ -1144,9 +1204,9 @@ The stored payment method available to the customer. ```json { - "details": "abc123", + "details": "xyz789", "payment_method_code": "xyz789", - "public_hash": "xyz789", + "public_hash": "abc123", "type": "card" } ``` @@ -1195,7 +1255,7 @@ Contains attributes specific to tangible products. #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -1228,8 +1288,8 @@ Defines Pickup Location information. ```json { - "city": "xyz789", - "contact_name": "xyz789", + "city": "abc123", + "contact_name": "abc123", "country_id": "abc123", "description": "xyz789", "email": "xyz789", @@ -1237,11 +1297,11 @@ Defines Pickup Location information. "latitude": 123.45, "longitude": 123.45, "name": "xyz789", - "phone": "xyz789", - "pickup_location_code": "abc123", - "postcode": "xyz789", + "phone": "abc123", + "pickup_location_code": "xyz789", + "postcode": "abc123", "region": "abc123", - "region_id": 987, + "region_id": 123, "street": "xyz789" } ``` @@ -1604,7 +1664,7 @@ Specifies the amount and type of price adjustment. #### Example ```json -{"amount": 987.65, "code": "abc123"} +{"amount": 123.45, "code": "xyz789"} ``` @@ -1626,7 +1686,7 @@ Can be used to retrieve the main price details in case of bundle product ```json { "discount_percentage": 123.45, - "main_final_price": 123.45, + "main_final_price": 987.65, "main_price": 123.45 } ``` @@ -1705,7 +1765,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -1721,7 +1781,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -1738,7 +1798,7 @@ Defines whether a bundle product's price is displayed as the lowest possible val #### Example ```json -{"message": "xyz789", "success": false} +{"message": "abc123", "success": false} ``` @@ -1759,7 +1819,7 @@ Contains a product attribute code and value. ```json { "code": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1781,9 +1841,9 @@ Contains a product attribute code and value. ```json { "attribute_type": "abc123", - "code": 4, - "url": "abc123", - "value": "abc123" + "code": "4", + "url": "xyz789", + "value": "xyz789" } ``` @@ -1825,7 +1885,7 @@ Contains the discount applied to a product price. #### Example ```json -{"amount_off": 123.45, "percent_off": 123.45} +{"amount_off": 987.65, "percent_off": 123.45} ``` @@ -1847,7 +1907,7 @@ Contains product image information, including the image URL and label. ```json { - "disabled": true, + "disabled": false, "label": "xyz789", "position": 123, "url": "abc123" @@ -1961,37 +2021,37 @@ Contains fields that are common to all types of products. "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": true, + "gift_message_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "abc123", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "abc123" } @@ -2017,10 +2077,10 @@ An implementation of `ProductLinksInterface`. ```json { - "link_type": "abc123", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", - "position": 123, + "link_type": "xyz789", + "linked_product_sku": "abc123", + "linked_product_type": "abc123", + "position": 987, "sku": "xyz789" } ``` @@ -2052,7 +2112,7 @@ Contains information about linked products, including the link type and product ```json { "link_type": "xyz789", - "linked_product_sku": "xyz789", + "linked_product_sku": "abc123", "linked_product_type": "abc123", "position": 123, "sku": "xyz789" @@ -2102,7 +2162,7 @@ Contains basic information about the video asset. ```json { "media_type": "xyz789", - "video_asset_id": "xyz789", + "video_asset_id": "abc123", "video_media_url": "xyz789" } ``` @@ -2129,10 +2189,10 @@ Contains a link to a video file and basic information about the video. ```json { "media_type": "xyz789", - "video_description": "xyz789", + "video_description": "abc123", "video_metadata": "xyz789", - "video_provider": "xyz789", - "video_title": "abc123", + "video_provider": "abc123", + "video_title": "xyz789", "video_url": "abc123" } ``` @@ -2212,9 +2272,9 @@ Contains the output of a `productSearch` query "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], + "related_terms": ["xyz789"], "suggestions": ["abc123"], - "total_count": 123, + "total_count": 987, "warnings": [ProductSearchWarning] } ``` @@ -2256,7 +2316,7 @@ Structured warning with code and message for easier client handling ```json { "code": "abc123", - "message": "xyz789" + "message": "abc123" } ``` @@ -2337,7 +2397,6 @@ Defines the product fields available to the SimpleProductView and ComplexProduct | `url` - [`String`](#string) | Canonical URL of the product. *(Deprecated: This field is deprecated and will be removed.)* | | `urlKey` - [`String`](#string) | The URL key of the product. This is a unique identifier for the product that is used to create the product's URL. | | `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, related, up-sell, and cross-sell links. | -| `categories` - [`[CategoryProductView!]`](#categoryproductview) | A list of categories in which the product is present. | | `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | | `visibility` - [`String`](#string) | Visibility setting of the product | @@ -2356,23 +2415,22 @@ Defines the product fields available to the SimpleProductView and ComplexProduct "inStock": false, "lowStock": true, "attributes": [ProductViewAttribute], - "description": "abc123", + "description": "xyz789", "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "abc123", + "metaDescription": "abc123", + "metaKeyword": "xyz789", "metaTitle": "abc123", "name": "xyz789", "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], "sku": "abc123", "externalId": "xyz789", - "url": "xyz789", + "url": "abc123", "urlKey": "xyz789", "links": [ProductViewLink], - "categories": [CategoryProductView], "queryType": "xyz789", "visibility": "abc123" } @@ -2397,9 +2455,9 @@ A container for customer-defined attributes that are displayed the storefront. ```json { - "label": "abc123", + "label": "xyz789", "name": "abc123", - "roles": ["abc123"], + "roles": ["xyz789"], "value": {} } ``` @@ -2611,7 +2669,7 @@ Contains details about a product image. { "label": "abc123", "roles": ["abc123"], - "url": "xyz789" + "url": "abc123" } ``` @@ -2641,15 +2699,15 @@ Product options provide a way to configure products by making selections of part ```json { "id": 4, - "title": "abc123", - "required": false, - "type": "abc123", + "title": "xyz789", + "required": true, + "type": "xyz789", "markupAmount": 987.65, "suffix": "xyz789", "sortOrder": 987, "range": ProductViewInputOptionRange, "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "abc123" + "fileExtensions": "xyz789" } ``` @@ -2669,7 +2727,7 @@ Dimensions of the image associated with the input option. #### Example ```json -{"width": 123, "height": 123} +{"width": 987, "height": 123} ``` @@ -2709,7 +2767,7 @@ The product link type. Contains details about product links for related products ```json { "product": ProductView, - "linkTypes": ["xyz789"] + "linkTypes": ["abc123"] } ``` @@ -2729,7 +2787,7 @@ Defines a monetary value, including a numeric value and a currency code. #### Example ```json -{"currency": "AED", "value": 987.65} +{"currency": "AED", "value": 123.45} ``` @@ -2752,9 +2810,9 @@ Product options provide a way to configure products by making selections of part ```json { - "id": "4", + "id": 4, "multi": true, - "required": false, + "required": true, "title": "xyz789", "values": [ProductViewOptionValue] } @@ -2787,8 +2845,8 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr ```json { "id": "4", - "title": "xyz789", - "inStock": false + "title": "abc123", + "inStock": true } ``` @@ -2810,9 +2868,9 @@ An implementation of ProductViewOptionValue for configuration values. ```json { - "id": "4", - "title": "xyz789", - "inStock": false + "id": 4, + "title": "abc123", + "inStock": true } ``` @@ -2842,7 +2900,7 @@ An implementation of ProductViewOptionValue that adds details about a simple pro "product": SimpleProductView, "quantity": 123.45, "title": "xyz789", - "inStock": true + "inStock": false } ``` @@ -2869,7 +2927,7 @@ An implementation of ProductViewOptionValueSwatch for swatches. "id": "4", "title": "xyz789", "type": "TEXT", - "value": "abc123", + "value": "xyz789", "inStock": true } ``` @@ -2896,7 +2954,7 @@ Base product price view. Contains the final price after discounts, the regular p "final": Price, "regular": Price, "tiers": [ProductViewTierPrice], - "roles": ["xyz789"] + "roles": ["abc123"] } ``` @@ -2995,7 +3053,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, #### Example ```json -{"gte": 123.45, "lt": 987.65} +{"gte": 987.65, "lt": 987.65} ``` @@ -3038,7 +3096,7 @@ Represents the results of a product variant search. ```json { "variants": [ProductViewVariant], - "cursor": "abc123" + "cursor": "xyz789" } ``` @@ -3062,7 +3120,7 @@ Contains details about a product video. For example, a video of the product bein ```json { "preview": ProductViewImage, - "url": "xyz789", + "url": "abc123", "description": "xyz789", "title": "abc123" } @@ -3127,8 +3185,8 @@ Contains details about a purchase order. "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } ``` @@ -3195,7 +3253,7 @@ Contains details about a single event in the approval flow of the purchase order "name": "xyz789", "role": "abc123", "status": "PENDING", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -3245,9 +3303,9 @@ Contains details about a purchase order approval rule. "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", - "created_by": "xyz789", - "description": "xyz789", + "created_at": "xyz789", + "created_by": "abc123", + "description": "abc123", "name": "abc123", "status": "ENABLED", "uid": "4", @@ -3341,7 +3399,7 @@ Contains approval rule condition details, including the quantity to be evaluated #### Example ```json -{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 987} +{"attribute": "GRAND_TOTAL", "operator": "MORE_THAN", "quantity": 123} ``` @@ -3366,9 +3424,9 @@ Defines a new purchase order approval rule. ```json { "applies_to": ["4"], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "abc123", + "description": "xyz789", "name": "abc123", "status": "ENABLED" } @@ -3453,7 +3511,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -3477,8 +3535,8 @@ Contains details about a comment. ```json { "author": Customer, - "created_at": "abc123", - "text": "xyz789", + "created_at": "xyz789", + "text": "abc123", "uid": 4 } ``` @@ -3522,10 +3580,10 @@ Contains details about a status change. ```json { - "activity": "abc123", - "created_at": "abc123", + "activity": "xyz789", + "created_at": "xyz789", "message": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -3547,7 +3605,7 @@ Contains details about approval roles applied to the purchase order and status c ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -3595,7 +3653,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -3661,8 +3719,8 @@ Defines the criteria to use to filter the list of purchase orders. { "company_purchase_orders": false, "created_date": FilterRangeTypeInput, - "my_approvals": false, - "require_my_approval": false, + "my_approvals": true, + "require_my_approval": true, "status": "PENDING" } ``` @@ -3723,7 +3781,7 @@ Sets quote template expiration date. ```json { - "expiration_date": "abc123", + "expiration_date": "xyz789", "template_id": "4" } ``` @@ -3748,7 +3806,7 @@ Sets quote item note. ```json { "item_id": "4", - "item_uid": 4, + "item_uid": "4", "note": "abc123", "templateId": "4" } @@ -3772,7 +3830,7 @@ Contains a notification message for a negotiable quote template. ```json { "message": "xyz789", - "type": "xyz789" + "type": "abc123" } ``` @@ -3796,8 +3854,8 @@ For use on numeric product fields ```json { "count": 987, - "from": 123.45, - "title": "xyz789", + "from": 987.65, + "title": "abc123", "to": 123.45 } ``` @@ -3852,7 +3910,7 @@ For use on numeric product fields #### Example ```json -{"from": 987.65, "to": 987.65} +{"from": 987.65, "to": 123.45} ``` @@ -3871,7 +3929,7 @@ For use on numeric product fields ```json { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } ``` @@ -3899,13 +3957,13 @@ Contains reCAPTCHA form configuration details. ```json { "badge_position": "xyz789", - "language_code": "abc123", + "language_code": "xyz789", "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", "technical_failure_message": "xyz789", "theme": "abc123", "validation_failure_message": "abc123", - "website_key": "xyz789" + "website_key": "abc123" } ``` @@ -3932,14 +3990,14 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "abc123", - "failure_message": "xyz789", + "badge_position": "xyz789", + "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, - "language_code": "xyz789", + "is_enabled": true, + "language_code": "abc123", "minimum_score": 123.45, - "theme": "abc123", - "website_key": "xyz789" + "theme": "xyz789", + "website_key": "abc123" } ``` @@ -4030,19 +4088,21 @@ Recommendation Unit containing product and other details | `typeId` - [`String`](#string) | Type of recommendation | | `unitId` - [`String`](#string) | Id of the preconfigured unit | | `unitName` - [`String`](#string) | Name of the preconfigured unit | +| `userError` - [`String`](#string) | User error message if the unit could not be fully resolved (e.g. required currentSku was not provided) | #### Example ```json { - "displayOrder": 987, - "pageType": "xyz789", + "displayOrder": 123, + "pageType": "abc123", "productsView": [ProductView], - "storefrontLabel": "abc123", + "storefrontLabel": "xyz789", "totalProducts": 987, "typeId": "abc123", "unitId": "xyz789", - "unitName": "xyz789" + "unitName": "abc123", + "userError": "xyz789" } ``` @@ -4062,7 +4122,7 @@ Recommendations response #### Example ```json -{"results": [RecommendationUnit], "totalResults": 123} +{"results": [RecommendationUnit], "totalResults": 987} ``` @@ -4082,7 +4142,7 @@ Recommendations response ```json { "code": "xyz789", - "id": 123, + "id": 987, "name": "xyz789" } ``` @@ -4102,7 +4162,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -4140,8 +4200,8 @@ Remove coupons from the cart. ```json { - "cart_id": "xyz789", - "coupon_codes": ["abc123"] + "cart_id": "abc123", + "coupon_codes": ["xyz789"] } ``` @@ -4162,8 +4222,8 @@ Defines the input required to run the `removeGiftCardFromCart` mutation. ```json { - "cart_id": "xyz789", - "gift_card_code": "abc123" + "cart_id": "abc123", + "gift_card_code": "xyz789" } ``` @@ -4218,7 +4278,7 @@ Contains the results of a request to delete a gift registry. #### Example ```json -{"success": true} +{"success": false} ``` @@ -4255,7 +4315,7 @@ Specifies which items to remove from the cart. #### Example ```json -{"cart_id": "abc123", "cart_item_uid": 4} +{"cart_id": "xyz789", "cart_item_uid": 4} ``` @@ -4292,7 +4352,7 @@ Defines the items to remove from the specified negotiable quote. #### Example ```json -{"quote_item_uids": [4], "quote_uid": 4} +{"quote_item_uids": [4], "quote_uid": "4"} ``` @@ -4329,7 +4389,7 @@ Defines the items to remove from the specified negotiable quote. #### Example ```json -{"item_uids": [4], "template_id": 4} +{"item_uids": ["4"], "template_id": 4} ``` @@ -4348,7 +4408,10 @@ Defines which products to remove from a compare list. #### Example ```json -{"products": [4], "uid": "4"} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -4388,7 +4451,7 @@ Defines the tracking information to delete. #### Example ```json -{"return_shipping_tracking_uid": "4"} +{"return_shipping_tracking_uid": 4} ``` @@ -4442,7 +4505,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -4546,8 +4609,8 @@ Contains information needed to start a return request. ```json { - "comment_text": "xyz789", - "contact_email": "xyz789", + "comment_text": "abc123", + "contact_email": "abc123", "items": [RequestReturnItemInput], "token": "abc123" } @@ -4574,7 +4637,7 @@ Defines properties of a negotiable quote request. { "cart_id": "4", "comment": NegotiableQuoteCommentInput, - "is_draft": false, + "is_draft": true, "quote_name": "xyz789" } ``` @@ -4612,7 +4675,7 @@ Defines properties of a negotiable quote template request. #### Example ```json -{"cart_id": 4} +{"cart_id": "4"} ``` @@ -4635,7 +4698,7 @@ Contains information needed to start a return request. ```json { "comment_text": "xyz789", - "contact_email": "abc123", + "contact_email": "xyz789", "items": [RequestReturnItemInput], "order_uid": "4" } @@ -4664,7 +4727,7 @@ Contains details about an item to be returned. EnteredCustomAttributeInput ], "order_item_uid": "4", - "quantity_to_return": 987.65, + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -4716,10 +4779,10 @@ Defines the contents of a requisition list. { "description": "xyz789", "items": RequistionListItems, - "items_count": 123, - "name": "abc123", + "items_count": 987, + "name": "xyz789", "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -4778,9 +4841,9 @@ The interface for requisition list items. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -4806,8 +4869,8 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["abc123"], + "quantity": 987.65, + "selected_options": ["xyz789"], "sku": "xyz789" } ``` @@ -4932,7 +4995,7 @@ Contains details about a return. "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -4956,7 +5019,7 @@ Contains details about a return comment. ```json { "author_name": "xyz789", - "created_at": "xyz789", + "created_at": "abc123", "text": "abc123", "uid": "4" } @@ -4980,9 +5043,9 @@ The customer information for the return. ```json { - "email": "xyz789", - "firstname": "abc123", - "lastname": "abc123" + "email": "abc123", + "firstname": "xyz789", + "lastname": "xyz789" } ``` @@ -5012,7 +5075,7 @@ Contains details about a product being returned. "quantity": 987.65, "request_quantity": 987.65, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -5047,15 +5110,15 @@ Return Item attribute metadata. "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": false, + "is_required": false, + "is_unique": true, "label": "xyz789", "multiline_count": 123, "options": [CustomAttributeOptionInterface], - "sort_order": 123, + "sort_order": 987, "validate_rules": [ValidationRule] } ``` @@ -5126,12 +5189,12 @@ Contains details about the shipping address used for receiving returned items. ```json { "city": "xyz789", - "contact_name": "abc123", + "contact_name": "xyz789", "country": Country, - "postcode": "xyz789", + "postcode": "abc123", "region": Region, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -5178,7 +5241,7 @@ Contains shipping and tracking details. { "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", + "tracking_number": "xyz789", "uid": "4" } ``` @@ -5199,7 +5262,7 @@ Contains the status of a shipment. #### Example ```json -{"text": "abc123", "type": "INFORMATION"} +{"text": "xyz789", "type": "INFORMATION"} ``` @@ -5267,7 +5330,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5286,7 +5349,7 @@ Contains the result of a request to revoke a customer token. #### Example ```json -{"result": true} +{"result": false} ``` @@ -5329,7 +5392,7 @@ Contains details about a customer's reward points. #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -5352,8 +5415,8 @@ Contain details about the reward points transaction. ```json { "balance": RewardPointsAmount, - "change_reason": "xyz789", - "date": "xyz789", + "change_reason": "abc123", + "date": "abc123", "points_change": 987.65 } ``` @@ -5455,7 +5518,7 @@ Defines the name and value of a SDK parameter ```json { - "name": "xyz789", + "name": "abc123", "value": "abc123" } ``` @@ -5478,7 +5541,7 @@ Contains details about a comment. ```json { "message": "xyz789", - "timestamp": "xyz789" + "timestamp": "abc123" } ``` @@ -5500,9 +5563,9 @@ For use on string and other scalar product fields ```json { - "count": 123, + "count": 987, "id": "4", - "title": "abc123" + "title": "xyz789" } ``` @@ -5528,30 +5591,6 @@ This enumeration defines the scope type for customer orders. -### SearchCategoryResultPage - -Represents a paginated result set of category search results. - -#### Fields - -| Field Name | Description | -|------------|-------------| -| `items` - [`[CategoryTreeView!]!`](#categorytreeview) | The list of categories matching the search criteria. | -| `totalCount` - [`Int!`](#int) | The total number of categories matching the search criteria across all pages. | -| `pageInfo` - [`PageInfo!`](#pageinfo) | Pagination information for navigating through results. | - -#### Example - -```json -{ - "items": [CategoryTreeView], - "totalCount": 987, - "pageInfo": PageInfo -} -``` - - - ### SearchClauseInput A product attribute to filter on @@ -5571,10 +5610,10 @@ A product attribute to filter on ```json { - "attribute": "xyz789", - "contains": "xyz789", + "attribute": "abc123", + "contains": "abc123", "eq": "abc123", - "in": ["xyz789"], + "in": ["abc123"], "range": SearchRangeInput, "startsWith": "abc123" } @@ -5596,7 +5635,7 @@ A range of numeric values for use in a search #### Example ```json -{"from": 123.45, "to": 123.45} +{"from": 987.65, "to": 123.45} ``` @@ -5616,7 +5655,7 @@ Provides navigation for the query response. #### Example ```json -{"current_page": 123, "page_size": 987, "total_pages": 987} +{"current_page": 987, "page_size": 123, "total_pages": 123} ``` @@ -5639,7 +5678,7 @@ Contains details about a selected bundle option. ```json { "label": "xyz789", - "type": "xyz789", + "type": "abc123", "uid": 4, "values": [SelectedBundleOptionValue] } @@ -5668,7 +5707,7 @@ Contains details about a value for a selected bundle option. "label": "xyz789", "original_price": Money, "priceV2": Money, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -5695,7 +5734,7 @@ Contains details about a selected configurable option. "configurable_product_option_uid": "4", "configurable_product_option_value_uid": 4, "option_label": "abc123", - "value_label": "abc123" + "value_label": "xyz789" } ``` @@ -5770,10 +5809,10 @@ Identifies the value of the selected customized option. ```json { - "customizable_option_value_uid": 4, - "label": "abc123", + "customizable_option_value_uid": "4", + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, - "value": "abc123" + "value": "xyz789" } ``` @@ -5799,7 +5838,7 @@ Describes the payment method selected by the shopper. "code": "xyz789", "oope_payment_method_config": OopePaymentMethodConfig, "purchase_order_number": "xyz789", - "title": "xyz789" + "title": "abc123" } ``` @@ -5831,7 +5870,7 @@ Contains details about the selected shipping method and carrier. "carrier_code": "xyz789", "carrier_title": "xyz789", "method_code": "xyz789", - "method_title": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -5895,7 +5934,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "xyz789" + "cart_id": "abc123" } ``` @@ -5933,7 +5972,7 @@ Sets the cart as inactive #### Example ```json -{"error": "abc123", "success": true} +{"error": "xyz789", "success": false} ``` @@ -5994,7 +6033,7 @@ Defines the negotiable quote custom attributes. ```json { "custom_attributes": [CustomAttributeInput], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -6038,9 +6077,9 @@ Defines the gift options applied to the cart. { "cart_id": "xyz789", "gift_message": GiftMessageInput, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping_id": 4, - "printed_card_included": true + "printed_card_included": false } ``` @@ -6079,8 +6118,8 @@ Defines the guest email and cart. ```json { - "cart_id": "abc123", - "email": "abc123" + "cart_id": "xyz789", + "email": "xyz789" } ``` @@ -6178,7 +6217,7 @@ Defines the payment method of the specified negotiable quote. ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -6217,7 +6256,7 @@ Defines the shipping address to assign to the negotiable quote. ```json { - "quote_uid": 4, + "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -6259,7 +6298,7 @@ Defines the shipping method to apply to the negotiable quote. ```json { - "quote_uid": 4, + "quote_uid": "4", "shipping_methods": [ShippingMethodInput] } ``` @@ -6300,7 +6339,7 @@ Defines the shipping address to assign to the negotiable quote template. ```json { "shipping_address": NegotiableQuoteTemplateShippingAddressInput, - "template_id": 4 + "template_id": "4" } ``` @@ -6488,6 +6527,133 @@ Defines the sender of an invitation to view a gift registry. +### ShareRequisitionListByEmailInput + +An input object that defines which requisition list shared with company users through email. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `customerUids` - [`[ID]!`](#id) | An array of IDs representing company users with whom the sender wants to share the requisition list. | +| `requisitionListUid` - [`ID!`](#id) | The unique ID of the requisition list. | + +#### Example + +```json +{ + "customerUids": ["4"], + "requisitionListUid": "4" +} +``` + + + +### ShareRequisitionListByEmailOutput + +Result of sharing a requisition list by email. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sent_count` - [`Int!`](#int) | Number of notification emails successfully sent. | +| `user_errors` - [`[ShareRequisitionListUserError]!`](#sharerequisitionlistusererror) | Per-email validation or delivery issues. | + +#### Example + +```json +{ + "sent_count": 987, + "user_errors": [ShareRequisitionListUserError] +} +``` + + + +### ShareRequisitionListByTokenOutput + +The result of sharing a requisition list by token. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `token` - [`String!`](#string) | Token used to generate a shareable link for the requisition list. | + +#### Example + +```json +{"token": "xyz789"} +``` + + + +### ShareRequisitionListUserError + +An error related to a specific recipient or constraint. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`ShareRequisitionListUserErrorCode!`](#sharerequisitionlistusererrorcode) | Machine-readable error code. | +| `message` - [`String!`](#string) | Human-readable error message. | + +#### Example + +```json +{ + "code": "MAX_RECIPIENTS_EXCEEDED", + "message": "abc123" +} +``` + + + +### ShareRequisitionListUserErrorCode + +Machine-readable error codes for requisition list share-by-email and import operations. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `MAX_RECIPIENTS_EXCEEDED` | | +| `INVALID_EMAIL` | | +| `NOT_COMPANY_USER` | | +| `IMPORT_FAILED` | | + +#### Example + +```json +""MAX_RECIPIENTS_EXCEEDED"" +``` + + + +### SharedRequisitionListOutput + +Shared requisition list view for a recipient. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList!`](#requisitionlist) | The sender's requisition list (read-only for the recipient). | +| `sender_name` - [`String!`](#string) | Display name of the requisition list sender. | + +#### Example + +```json +{ + "requisition_list": RequisitionList, + "sender_name": "xyz789" +} +``` + + + ### ShipBundleItemsEnum Defines whether bundle items must be shipped together. @@ -6526,10 +6692,10 @@ Defines whether bundle items must be shipped together. { "id": "4", "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 987.65 + "quantity_shipped": 123.45 } ``` @@ -6566,7 +6732,7 @@ Order shipment item details. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 987.65 } ``` @@ -6584,14 +6750,16 @@ Contains order shipment tracking details. | `carrier` - [`String!`](#string) | The shipping carrier for the order delivery. | | `number` - [`String`](#string) | The tracking number of the order shipment. | | `title` - [`String!`](#string) | The shipment tracking title. | +| `tracking_url` - [`String`](#string) | The tracking URL for the shipment. Available for both built-in and custom shipping carriers when a URL template is configured. | #### Example ```json { - "carrier": "xyz789", + "carrier": "abc123", "number": "xyz789", - "title": "abc123" + "title": "abc123", + "tracking_url": "abc123" } ``` @@ -6639,8 +6807,8 @@ Defines a single shipping address. { "address": CartAddressInput, "customer_address_id": 123, - "customer_address_uid": 4, - "customer_notes": "xyz789", + "customer_address_uid": "4", + "customer_notes": "abc123", "pickup_location_code": "abc123" } ``` @@ -6686,14 +6854,14 @@ Contains shipping addresses and methods. { "available_shipping_methods": [AvailableShippingMethod], "cart_items_v2": [CartItemInterface], - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", - "customer_notes": "xyz789", + "customer_notes": "abc123", "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, "lastname": "xyz789", "middlename": "xyz789", @@ -6704,7 +6872,7 @@ Contains shipping addresses and methods. "same_as_billing": false, "selected_shipping_method": SelectedShippingMethod, "street": ["xyz789"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "xyz789", "uid": "4", "vat_id": "abc123" @@ -6790,16 +6958,18 @@ An implementation for simple product cart items. | Field Name | Description | |------------|-------------| | `available_gift_wrapping` - [`[GiftWrapping]!`](#giftwrapping) | The list of available gift wrapping options for the cart item. | +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing the customizable options the shopper selected. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | | `gift_message` - [`GiftMessage`](#giftmessage) | The entered gift message for the cart item | | `gift_wrapping` - [`GiftWrapping`](#giftwrapping) | The selected gift wrapping for the cart item. | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -6812,6 +6982,7 @@ An implementation for simple product cart items. ```json { "available_gift_wrapping": [GiftWrapping], + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -6819,15 +6990,16 @@ An implementation for simple product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "max_qty": 987.65, + "is_salable": false, + "max_qty": 123.45, "min_qty": 987.65, "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -6889,25 +7061,25 @@ Defines a simple product, which is tangible and is usually sold in single units { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "xyz789", - "min_sale_qty": 987.65, + "meta_title": "abc123", + "min_sale_qty": 123.45, "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], "options_container": "abc123", @@ -6926,7 +7098,7 @@ Defines a simple product, which is tangible and is usually sold in single units "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "weight": 123.45 } ``` @@ -6962,7 +7134,6 @@ Represents a single-SKU product without selectable variants. Because there are n | `url` - [`String`](#string) | Canonical URL of the product. For example, `https://example.com/product-1` or `https://example.com/product-2`. *(Deprecated: This field is deprecated and will be removed.)* | | `urlKey` - [`String`](#string) | The URL key of the product. For example, `product-1`, `product-2` or `product-3`. | | `links` - [`[ProductViewLink]`](#productviewlink) | A list of product links. For example, a related product, an up-sell product or a cross-sell product. | -| `categories` - [`[CategoryProductView!]`](#categoryproductview) | A list of categories in which the product is present. Categories are used to group products by category. | | `queryType` - [`String`](#string) | Indicates if the product was retrieved from the primary or the backup query | | `visibility` - [`String`](#string) | Visibility setting of the product | @@ -6980,20 +7151,19 @@ Represents a single-SKU product without selectable variants. Because there are n "videos": [ProductViewVideo], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "xyz789", - "metaTitle": "xyz789", + "metaDescription": "xyz789", + "metaKeyword": "abc123", + "metaTitle": "abc123", "name": "abc123", "price": ProductViewPrice, "shortDescription": "abc123", "sku": "abc123", - "externalId": "abc123", + "externalId": "xyz789", "url": "xyz789", - "urlKey": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], - "categories": [CategoryProductView], - "queryType": "xyz789", - "visibility": "abc123" + "queryType": "abc123", + "visibility": "xyz789" } ``` @@ -7019,9 +7189,9 @@ Contains details about simple products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -7046,9 +7216,9 @@ Contains a simple product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, "quantity": 123.45 @@ -7073,8 +7243,8 @@ Smart button payment inputs ```json { - "payment_source": "xyz789", - "payments_order_id": "xyz789", + "payment_source": "abc123", + "payments_order_id": "abc123", "paypal_order_id": "abc123" } ``` @@ -7106,13 +7276,13 @@ Smart button payment inputs "app_switch_when_available": true, "button_styles": ButtonStyles, "code": "abc123", - "display_message": true, + "display_message": false, "display_venmo": false, - "is_visible": true, + "is_visible": false, "message_styles": MessageStyles, - "payment_intent": "abc123", + "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", + "sort_order": "xyz789", "title": "xyz789" } ``` @@ -7154,7 +7324,7 @@ Defines a possible sort field. ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -7249,10 +7419,10 @@ Contains product attributes that be used for sorting in a `productSearch` query ```json { - "attribute": "abc123", + "attribute": "xyz789", "frontendInput": "xyz789", - "label": "xyz789", - "numeric": false + "label": "abc123", + "numeric": true } ``` @@ -7274,8 +7444,8 @@ For retrieving statistics across multiple buckets ```json { - "max": 987.65, - "min": 987.65, + "max": 123.45, + "min": 123.45, "title": "abc123" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-4.md b/src/pages/includes/autogenerated/graphql-api-saas-types-4.md index 89e0eb4d3..247f85d68 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-4.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-4.md @@ -109,6 +109,10 @@ Contains information about a store's configuration. | `quote_minimum_amount` - [`Float`](#float) | Minimum order total for quote request. | | `quote_minimum_amount_message` - [`String`](#string) | A message that will be shown in the cart when the subtotal (after discount) is lower than the minimum allowed amount. | | `required_character_classes_number` - [`String`](#string) | The number of different character classes (lowercase, uppercase, digits, special characters) required in a password. | +| `requisition_list_share_link_validity_days` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | +| `requisition_list_share_max_recipients` - [`Int!`](#int) | Configuration data from btob/requisition_list_sharing/max_recipients | +| `requisition_list_share_storefront_path` - [`String!`](#string) | Configuration data from btob/requisition_list_sharing/storefront_share_path (route path for share links, no leading or trailing slashes) | +| `requisition_list_sharing_enabled` - [`Boolean!`](#boolean) | Configuration data from btob/requisition_list_sharing/enabled | | `returns_enabled` - [`String!`](#string) | Indicates whether RMA is enabled on the storefront. Possible values: enabled/disabled. | | `root_category_uid` - [`ID`](#id) | The unique ID for a `CategoryInterface` object. | | `sales_fixed_product_tax_display_setting` - [`FixedProductTaxDisplaySettings`](#fixedproducttaxdisplaysettings) | Corresponds to the 'Display Prices In Sales Modules' field in the Admin. It indicates how FPT information is displayed on cart, checkout, and order pages. | @@ -120,6 +124,9 @@ Contains information about a store's configuration. | `secure_base_url` - [`String`](#string) | The store’s fully-qualified secure base URL. | | `share_active_segments` - [`Boolean!`](#boolean) | Configuration data from customer/magento_customersegment/share_active_segments | | `share_applied_cart_rule` - [`Boolean!`](#boolean) | Configuration data from promo/graphql/share_applied_cart_rule | +| `shopping_assistance_checkbox_title` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_title | +| `shopping_assistance_checkbox_tooltip` - [`String`](#string) | Configuration data from login_as_customer/general/shopping_assistance_checkbox_tooltip | +| `shopping_assistance_enabled` - [`Boolean!`](#boolean) | Configuration data from login_as_customer/general/enabled | | `shopping_cart_display_full_summary` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/full_summary | | `shopping_cart_display_grand_total` - [`Boolean`](#boolean) | Extended Config Data - tax/cart_display/grandtotal | | `shopping_cart_display_price` - [`Int`](#int) | Extended Config Data - tax/cart_display/price | @@ -151,144 +158,151 @@ Contains information about a store's configuration. ```json { "allow_company_registration": false, - "allow_gift_receipt": "xyz789", + "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", "allow_items": "abc123", - "allow_order": "abc123", + "allow_order": "xyz789", "allow_printed_card": "abc123", "autocomplete_on_storefront": false, - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_link_url": "abc123", - "base_media_url": "xyz789", + "base_media_url": "abc123", "base_static_url": "abc123", "base_url": "xyz789", "cart_expires_in_days": 987, "cart_gift_wrapping": "abc123", - "cart_merge_preference": "abc123", + "cart_merge_preference": "xyz789", "cart_printed_card": "abc123", "cart_summary_display_quantity": 123, "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "xyz789", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": false, - "check_money_order_make_check_payable_to": "abc123", + "category_url_suffix": "abc123", + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": true, + "check_money_order_make_check_payable_to": "xyz789", "check_money_order_max_order_total": "abc123", - "check_money_order_min_order_total": "xyz789", + "check_money_order_min_order_total": "abc123", "check_money_order_new_order_status": "abc123", - "check_money_order_payment_from_specific_countries": "xyz789", - "check_money_order_send_check_to": "xyz789", + "check_money_order_payment_from_specific_countries": "abc123", + "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", "company_credit_enabled": false, - "company_enabled": true, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "countries_with_required_region": "xyz789", + "contact_enabled": false, + "countries_with_required_region": "abc123", "create_account_confirmation": true, - "customer_access_token_lifetime": 123.45, + "customer_access_token_lifetime": 987.65, "default_country": "xyz789", "default_display_currency_code": "xyz789", - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 123, "display_state_if_optional": false, - "enable_multiple_wishlists": "abc123", + "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": true, - "fixed_product_taxes_display_prices_in_emails": 123, - "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_emails": 987, + "fixed_product_taxes_display_prices_in_product_lists": 987, "fixed_product_taxes_display_prices_in_sales_modules": 123, "fixed_product_taxes_display_prices_on_product_view_page": 987, "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, - "grid_per_page": 987, + "grid_per_page": 123, "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", "is_checkout_agreements_enabled": true, - "is_default_store": false, + "is_default_store": true, "is_default_store_group": false, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": true, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": false, "is_one_page_checkout_enabled": false, "is_requisition_list_active": "abc123", "list_mode": "xyz789", - "list_per_page": 987, - "list_per_page_values": "xyz789", - "locale": "abc123", - "magento_reward_general_is_enabled": "xyz789", + "list_per_page": 123, + "list_per_page_values": "abc123", + "locale": "xyz789", + "magento_reward_general_is_enabled": "abc123", "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "abc123", - "magento_reward_general_publish_history": "abc123", + "magento_reward_general_min_points_balance": "xyz789", + "magento_reward_general_publish_history": "xyz789", "magento_reward_points_invitation_customer": "xyz789", - "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "abc123", + "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", + "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "abc123", - "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "xyz789", + "magento_reward_points_register": "abc123", + "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "xyz789", "minicart_display": true, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": false, "optional_zip_countries": "abc123", - "order_cancellation_enabled": true, + "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], - "orders_invoices_credit_memos_display_full_summary": true, - "orders_invoices_credit_memos_display_grandtotal": true, + "orders_invoices_credit_memos_display_full_summary": false, + "orders_invoices_credit_memos_display_grandtotal": false, "orders_invoices_credit_memos_display_price": 987, - "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_shipping_amount": 123, "orders_invoices_credit_memos_display_subtotal": 123, "orders_invoices_credit_memos_display_zero_tax": false, "printed_card_priceV2": Money, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_url_suffix": "abc123", + "product_url_suffix": "xyz789", "quickorder_active": false, - "quote_minimum_amount": 987.65, + "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "abc123", "required_character_classes_number": "xyz789", + "requisition_list_share_link_validity_days": 123, + "requisition_list_share_max_recipients": 123, + "requisition_list_share_storefront_path": "xyz789", + "requisition_list_sharing_enabled": false, "returns_enabled": "xyz789", "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", - "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "sales_gift_wrapping": "abc123", + "sales_printed_card": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "xyz789", "secure_base_static_url": "abc123", "secure_base_url": "xyz789", "share_active_segments": true, - "share_applied_cart_rule": false, + "share_applied_cart_rule": true, + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "abc123", + "shopping_assistance_enabled": false, "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, + "shopping_cart_display_price": 987, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": false, - "store_code": 4, - "store_group_code": "4", + "store_code": "4", + "store_group_code": 4, "store_group_name": "abc123", "store_name": "abc123", "store_sort_order": 123, - "timezone": "xyz789", - "title_separator": "abc123", + "timezone": "abc123", + "title_separator": "xyz789", "use_store_in_url": true, - "website_code": "4", - "website_name": "abc123", + "website_code": 4, + "website_name": "xyz789", "weight_unit": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "abc123", + "zero_subtotal_enabled": false, + "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "abc123", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "abc123" + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "xyz789" } ``` @@ -301,7 +315,7 @@ The `String` scalar type represents textual data, represented as UTF-8 character #### Example ```json -"xyz789" +"abc123" ``` @@ -363,8 +377,8 @@ Specifies the quote template properties to update. "attachments": [NegotiableQuoteCommentAttachmentInput], "comment": "xyz789", "max_order_commitment": 123, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], @@ -451,7 +465,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -528,7 +542,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "xyz789" + "id": "abc123" } ``` @@ -636,6 +650,42 @@ Defines a price based on the quantity purchased. +### UnassignChildCompanyInput + +Defines the input schema for unassigning a child company from its parent company. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `child_company_id` - [`ID!`](#id) | The unique ID of the child company. | + +#### Example + +```json +{"child_company_id": 4} +``` + + + +### UnassignChildCompanyOutput + +Contains the response to the request to unassign a child company. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `company_hierarchy` - [`CompanyHierarchy!`](#companyhierarchy) | The updated company relation hierarchy for the current company. | + +#### Example + +```json +{"company_hierarchy": CompanyHierarchy} +``` + + + ### UnitConfigInput #### Input Fields @@ -655,12 +705,12 @@ Defines a price based on the quantity purchased. ```json { - "unitName": "xyz789", - "storefrontLabel": "xyz789", + "unitName": "abc123", + "storefrontLabel": "abc123", "pagePlacement": "xyz789", - "displayNumber": 987, + "displayNumber": 123, "pageType": "xyz789", - "unitStatus": "abc123", + "unitStatus": "xyz789", "typeId": "xyz789", "filterRules": [FilterRuleInput] } @@ -824,8 +874,8 @@ Defines updates to a `GiftRegistry` object. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "xyz789", - "message": "abc123", + "event_name": "abc123", + "message": "xyz789", "privacy_settings": "PRIVATE", "shipping_address": GiftRegistryShippingAddressInput, "status": "ACTIVE" @@ -915,10 +965,10 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "abc123", - "firstname": "abc123", - "gift_registry_registrant_uid": "4", - "lastname": "xyz789" + "email": "xyz789", + "firstname": "xyz789", + "gift_registry_registrant_uid": 4, + "lastname": "abc123" } ``` @@ -976,7 +1026,7 @@ Specifies the items to update. ```json { "items": [NegotiableQuoteItemQuantityInput], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -1065,7 +1115,7 @@ Defines the changes to be made to an approval rule. ```json { "applies_to": [4], - "approvers": [4], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", "name": "abc123", @@ -1091,8 +1141,8 @@ An input object that defines which requistion list characteristics to update. ```json { - "description": "abc123", - "name": "xyz789" + "description": "xyz789", + "name": "abc123" } ``` @@ -1116,8 +1166,8 @@ Defines which items in a requisition list to update. ```json { "entered_options": [EnteredOptionInput], - "item_id": "4", - "quantity": 987.65, + "item_id": 4, + "quantity": 123.45, "selected_options": ["xyz789"] } ``` @@ -1177,7 +1227,7 @@ Contains the name and visibility of an updated wish list. ```json { "name": "abc123", - "uid": 4, + "uid": "4", "visibility": "PUBLIC" } ``` @@ -1200,7 +1250,7 @@ Defines the input for returning matching companies the customer is assigned to. ```json { - "currentPage": 123, + "currentPage": 987, "pageSize": 123, "sort": [CompaniesSortInput] } @@ -1325,7 +1375,7 @@ Defines a customer attribute validation rule. ```json { "name": "DATE_RANGE_MAX", - "value": "abc123" + "value": "xyz789" } ``` @@ -1389,7 +1439,7 @@ Retrieves the vault configuration ```json { - "is_vault_enabled": true, + "is_vault_enabled": false, "sdk_params": [SDKParams], "three_ds_mode": "OFF" } @@ -1417,7 +1467,7 @@ Vault payment inputs "payment_source": "xyz789", "payments_order_id": "xyz789", "paypal_order_id": "xyz789", - "public_hash": "xyz789" + "public_hash": "abc123" } ``` @@ -1493,14 +1543,16 @@ An implementation for virtual product cart items. | Field Name | Description | |------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing hint when the line is salable on notify backorders with insufficient physical quantity; null otherwise. | | `custom_attributes` - [`[CustomAttribute]`](#customattribute) | The custom attributes for the cart item | | `customizable_options` - [`[SelectedCustomizableOption]!`](#selectedcustomizableoption) | An array containing customizable options the shopper selected. | | `discount` - [`[Discount]`](#discount) | Contains discount for quote line item. | | `errors` - [`[CartItemError]`](#cartitemerror) | An array of errors encountered while loading the cart item | -| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. | +| `is_available` - [`Boolean!`](#boolean) | True if requested quantity is less than available stock, false otherwise. *(Deprecated: Use `is_salable` instead. It indicates whether the line can be purchased, including backorder configuration.)* | +| `is_salable` - [`Boolean!`](#boolean) | True when the item can be purchased and should not block checkout: stock status is in stock and either physical quantity covers the requested quantity or backorders are allowed. | | `max_qty` - [`Float`](#float) | Line item max qty in quote template | | `min_qty` - [`Float`](#float) | Line item min qty in quote template | -| `not_available_message` - [`String`](#string) | Message to display when the product is not available with this selected option. | +| `not_available_message` - [`String`](#string) | Shortage or unavailability message for the line; null when the item is salable. | | `note_from_buyer` - [`[ItemNote]`](#itemnote) | The buyer's quote line item note. | | `note_from_seller` - [`[ItemNote]`](#itemnote) | The seller's quote line item note. | | `prices` - [`CartItemPrices`](#cartitemprices) | Contains details about the price of the item, including taxes and discounts. | @@ -1512,11 +1564,13 @@ An implementation for virtual product cart items. ```json { + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": false, + "is_available": true, + "is_salable": false, "max_qty": 987.65, "min_qty": 987.65, "not_available_message": "xyz789", @@ -1586,21 +1640,21 @@ Defines a virtual product, which is a non-tangible product that does not require { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 123.45, "name": "abc123", "new_from_date": "abc123", @@ -1614,16 +1668,16 @@ Defines a virtual product, which is a non-tangible product that does not require "quantity": 987.65, "related_products": [ProductInterface], "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -1649,9 +1703,9 @@ Contains details about virtual products added to a requisition list. { "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "sku": "abc123", - "uid": "4" + "quantity": 987.65, + "sku": "xyz789", + "uid": 4 } ``` @@ -1678,7 +1732,7 @@ Contains a virtual product wish list item. { "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "xyz789", + "description": "abc123", "id": 4, "product": ProductInterface, "quantity": 987.65 @@ -1748,12 +1802,12 @@ Contains a customer wish list. ```json { - "id": "4", - "items_count": 123, + "id": 4, + "items_count": 987, "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "abc123", - "updated_at": "xyz789", + "name": "xyz789", + "sharing_code": "xyz789", + "updated_at": "abc123", "visibility": "PUBLIC" } ``` @@ -1779,7 +1833,7 @@ Contains details about errors encountered when a customer added wish list items { "code": "PRODUCT_NOT_FOUND", "message": "abc123", - "wishlistId": "4", + "wishlistId": 4, "wishlistItemId": 4 } ``` @@ -1822,10 +1876,7 @@ Specifies the IDs of items to copy and their quantities. #### Example ```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1849,9 +1900,9 @@ Defines the items to add to a wish list. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", + "parent_sku": "abc123", "quantity": 123.45, - "selected_options": ["4"], + "selected_options": [4], "sku": "abc123" } ``` @@ -1892,7 +1943,7 @@ The interface for wish list items. "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", - "id": "4", + "id": 4, "product": ProductInterface, "quantity": 123.45 } @@ -1914,10 +1965,7 @@ Specifies the IDs of the items to move and their quantities. #### Example ```json -{ - "quantity": 987.65, - "wishlist_item_id": "4" -} +{"quantity": 987.65, "wishlist_item_id": 4} ``` @@ -1940,7 +1988,7 @@ Defines updates to items in a wish list. ```json { - "description": "abc123", + "description": "xyz789", "entered_options": [EnteredOptionInput], "quantity": 987.65, "selected_options": ["4"], @@ -2025,9 +2073,9 @@ Defines the wish list visibility types. ```json { - "key": "abc123", - "message": "xyz789", - "success": false + "key": "xyz789", + "message": "abc123", + "success": true } ``` @@ -2068,7 +2116,7 @@ Defines the wish list visibility types. ```json { "expires_at": "xyz789", - "key": "xyz789", - "upload_url": "xyz789" + "key": "abc123", + "upload_url": "abc123" } ```