From 395b09d6a514a741ededdf678707070eea8903ca Mon Sep 17 00:00:00 2001 From: Jared Hoover Date: Thu, 8 Oct 2026 13:38:05 -0500 Subject: [PATCH] ACCS Schema Update October --- spectaql/schema_saas.json | 739 ++++++++++++++++- src/openapi/accs-schema.yaml | 633 +++++++++++++- .../graphql-api-saas-mutations.md | 561 ++++++++----- .../autogenerated/graphql-api-saas-queries.md | 696 +++++++++------- .../graphql-api-saas-types-a-b.md | 319 ++++--- .../graphql-api-saas-types-c-e.md | 776 +++++++++--------- .../graphql-api-saas-types-f-i.md | 322 ++++---- .../graphql-api-saas-types-k-p.md | 524 +++++++----- .../graphql-api-saas-types-q-s.md | 581 +++++++------ .../graphql-api-saas-types-t-z.md | 102 +-- 10 files changed, 3523 insertions(+), 1730 deletions(-) diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index 50bda78d9..e83482a48 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -1453,6 +1453,106 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "AddPublicRequisitionListItemsToCartInput", + "description": "An input object that identifies the public requisition list, the target cart, and which items to add.", + "fields": null, + "inputFields": [ + { + "name": "cart_id", + "description": "The masked ID of the target cart. Obtain a guest cart ID via the createGuestCart mutation.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "item_uids", + "description": "UIDs of specific requisition list items to add. When omitted, every item in the list is added.", + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "token", + "description": "The public token identifying 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": "AddPublicRequisitionListItemsToCartOutput", + "description": "Contains the updated cart and any errors encountered while adding items.", + "fields": [ + { + "name": "cart", + "description": "The updated cart.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Cart", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "user_errors", + "description": "Errors encountered, e.g. NOT_PUBLIC, INVALID_TOKEN, or RESTRICTED_PRODUCT. Empty array means the operation succeeded. Items rejected as RESTRICTED_PRODUCT (outside the caller's shared catalog) are skipped rather than failing the whole request.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicRequisitionListUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "AddPurchaseOrderCommentInput", @@ -4239,6 +4339,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeRangeOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "attributeName", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "value", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "RangeValueInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "AttributeSelectedOption", @@ -4504,6 +4643,53 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "AttributeStringOperatorInput", + "description": null, + "fields": null, + "inputFields": [ + { + "name": "attributeName", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "values", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "AttributeValue", @@ -23117,6 +23303,16 @@ }, "defaultValue": null }, + { + "name": "is_public", + "description": "Indicates whether the requisition list is publicly shareable. Optional; defaults to false (private) when omitted.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, { "name": "name", "description": "The name assigned to the requisition list.", @@ -34326,6 +34522,12 @@ "description": null, "isDeprecated": false, "deprecationReason": null + }, + { + "name": "ATTRIBUTE", + "description": null, + "isDeprecated": false, + "deprecationReason": null } ], "possibleTypes": null @@ -43664,6 +43866,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "addPublicRequisitionListItemsToCart", + "description": "Add items from a public requisition list (identified by token) to a cart. Does not require authentication; guests must supply a cart_id obtained via createGuestCart. Omit item_uids to add every item in the list.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "AddPublicRequisitionListItemsToCartInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "AddPublicRequisitionListItemsToCartOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "addPurchaseOrderComment", "description": "Add a comment to an existing purchase order.", @@ -47714,6 +47943,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "sharePublicRequisitionList", + "description": "Email the requisition list's public share link (existing token, reused) to one or more email addresses. Fails with a user error if the list has not been marked public. Only the list owner may call this mutation.", + "args": [ + { + "name": "input", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "SharePublicRequisitionListInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "SharePublicRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "shareRequisitionListByEmail", "description": "Share a requisition list with company colleagues via email using a secure link.", @@ -53303,6 +53559,26 @@ "ofType": null }, "defaultValue": null + }, + { + "name": "attributeStringOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeStringOperatorInput", + "ofType": null + }, + "defaultValue": null + }, + { + "name": "attributeRangeOperator", + "description": null, + "type": { + "kind": "INPUT_OBJECT", + "name": "AttributeRangeOperatorInput", + "ofType": null + }, + "defaultValue": null } ], "interfaces": null, @@ -61935,6 +62211,169 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "PublicRequisitionListOutput", + "description": "Contains a public requisition list and its owner's display name.", + "fields": [ + { + "name": "requisition_list", + "description": "The shared requisition list and its items.", + "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 owner (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": "OBJECT", + "name": "PublicRequisitionListUserError", + "description": "Contains error details for a failed public requisition list operation.", + "fields": [ + { + "name": "code", + "description": "An error code identifying the failure type.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "ENUM", + "name": "PublicRequisitionListUserErrorCode", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "message", + "description": "A localized 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": "PublicRequisitionListUserErrorCode", + "description": "Error codes for public requisition list operations.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": [ + { + "name": "NOT_PUBLIC", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_TOKEN", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RESTRICTED_PRODUCT", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "MAX_RECIPIENTS_EXCEEDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "RATE_LIMIT_EXCEEDED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "INVALID_EMAIL", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNAVAILABLE_SKU", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OPTIONS_UPDATED", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "OUT_OF_STOCK", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "LOW_QUANTITY", + "description": "", + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "UNKNOWN_ERROR", + "description": "", + "isDeprecated": false, + "deprecationReason": null + } + ], + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "PurchaseHistory", @@ -65068,6 +65507,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "publicRequisitionList", + "description": "Return a requisition list marked public, identified by its token. Throws a GraphQL error if the token is invalid or the list is no longer public. Does not require authentication.", + "args": [ + { + "name": "token", + "description": "The public token identifying the requisition list.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "PublicRequisitionListOutput", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "recaptchaFormConfig", "description": null, @@ -65146,6 +65612,53 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "reviews", + "description": "Return the approved reviews for the specified product SKU. Standalone root query, not a Federation extension on ProductView, since a plain root field does not need @key / _entities.", + "args": [ + { + "name": "sku", + "description": "The SKU of the product to return reviews for.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + }, + "defaultValue": null + }, + { + "name": "pageSize", + "description": "The maximum number of results to return at once. The default is 20.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "20" + }, + { + "name": "currentPage", + "description": "The page of results to return. The default is 1.", + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "defaultValue": "1" + } + ], + "type": { + "kind": "OBJECT", + "name": "ProductReviews", + "ofType": null + }, + "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.", @@ -65175,11 +65688,11 @@ }, { "name": "sourceAvailability", - "description": "Per-source availability for one or more SKUs, scoped to the storefront-visible sources of the current sales channel's stock. Availability is computed identically to the order-placement guard.", + "description": "Per-source availability for one or more SKUs, scoped to the storefront-visible sources of the current sales channel's stock. Availability is computed identically to the order-placement guard. Only SKUs of products the shopper may see in the current website's catalog are reported.", "args": [ { "name": "skus", - "description": "The product SKUs to report availability for.", + "description": "The product SKUs to report availability for. A SKU that matches no product, whose product is not assigned to the current website or is disabled in the current store, or that the shopper's customer group may not see in the catalog (B2B shared catalog assignment or category permissions) is silently omitted from the response.", "type": { "kind": "NON_NULL", "name": null, @@ -67955,6 +68468,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "is_public", + "description": "Indicates whether this requisition list is currently publicly shareable. Defaults to false.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "items", "description": "An array of products added to the requisition list.", @@ -68053,6 +68582,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "token", + "description": "The list's public share token. Only resolved for the authenticated owner querying their own list; null for all other viewers, even when is_public is true.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "uid", "description": "The unique requisition list ID.", @@ -72582,6 +73123,96 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "SharePublicRequisitionListInput", + "description": "An input object that identifies the requisition list to share and the email addresses to send it to.", + "fields": null, + "inputFields": [ + { + "name": "emails", + "description": "One or more recipient email addresses. Not limited to registered customers.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + }, + "defaultValue": null + }, + { + "name": "requisition_list_uid", + "description": "The unique UID of the requisition list to share.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "ID", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", + "name": "SharePublicRequisitionListOutput", + "description": "Contains the number of emails successfully sent and any errors encountered.", + "fields": [ + { + "name": "sent_count", + "description": "Number of 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": "Errors encountered, e.g. NOT_PUBLIC when the list has not been marked public.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "PublicRequisitionListUserError", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "ShareRequisitionListByEmailInput", @@ -75349,6 +75980,34 @@ "name": "SkuSourceAvailability", "description": "Per-source availability for a single SKU across the sources of the current sales channel's stock.", "fields": [ + { + "name": "backorder_message", + "description": "Customer-facing pre-order notice, populated only when the SKU is saleable solely because notify-mode backorders are enabled and salable quantity is depleted (net of open reservations and the out-of-stock threshold); null otherwise (salable quantity remaining, silent backorders, or not saleable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_saleable", + "description": "Whether the SKU can be purchased right now, backorders considered: true when it is in stock, or out of stock with backorders enabled. This is the authoritative Add to Cart gate — gate on this, not on the per-source is_in_stock (which is a physical-inventory statement). Returned for every reported SKU regardless of whether per-source disclosure is enabled for the store; an unknown SKU, or one hidden from the shopper's catalog, is not reported at all.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "sku", "description": "The product SKU the availability applies to.", @@ -75367,7 +76026,7 @@ }, { "name": "sources", - "description": "Availability at each reported source.", + "description": "Availability at each reported source. Empty when per-source disclosure is not enabled for the store (cataloginventory/source_availability/storefront_enabled off); is_saleable and backorder_message are still returned.", "args": [], "type": { "kind": "NON_NULL", @@ -77713,6 +78372,70 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "requisition_list_public_share_link_validity_days", + "description": "Configuration data from btob/requisition_list_public_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_public_share_max_recipients", + "description": "Configuration data from btob/requisition_list_public_sharing/max_recipients", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "requisition_list_public_share_storefront_path", + "description": "Configuration data from btob/requisition_list_public_sharing/storefront_share_path (route path for public 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_public_sharing_enabled", + "description": "Configuration data from btob/requisition_list_public_sharing/enabled", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "requisition_list_share_link_validity_days", "description": "Configuration data from btob/requisition_list_sharing/link_validity_days", @@ -80069,6 +80792,16 @@ }, "defaultValue": null }, + { + "name": "is_public", + "description": "Indicates whether the requisition list is publicly shareable. Optional; pass true to make the list public or false to make it private again. When omitted, the current value is left unchanged.", + "type": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + }, + "defaultValue": null + }, { "name": "name", "description": "The new name of the requisition list.", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index b5e2c5adc..22aac7039 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -2104,6 +2104,158 @@ definitions: - orders - limit type: object + catalog-price-rule-api-data-catalog-price-rule-interface: + description: 'Data interface for a catalog price rule exposed over REST. This + is a constrained view of the underlying rule: it adds the scoping and date fields + the vendor @api RuleInterface omits, and exposes the condition tree as typed, + server-validated leaves and nested groups instead of raw arrays.' + properties: + condition: + "$ref": "#/definitions/catalog-price-rule-api-data-rule-condition-interface" + customer_group_ids: + description: The customer group IDs the rule applies to. + items: + type: integer + type: array + description: + description: The rule description. + type: string + discount_amount: + description: The discount amount. + type: number + from_date: + description: From boundary; YYYY-MM-DD uses Admin-timezone day start, while + YYYY-MM-DD HH:MM:SS uses UTC. + type: string + is_active: + description: The active flag (0 or 1). + type: integer + name: + description: The rule name. + type: string + rule_id: + description: The rule ID. + type: integer + simple_action: + description: The discount action (one of VALID_SIMPLE_ACTIONS). + type: string + sort_order: + description: The rule sort order (priority). + type: integer + stop_rules_processing: + description: The stop-rules-processing flag (0 or 1). + type: integer + to_date: + description: To boundary; YYYY-MM-DD uses Admin-timezone day end, while YYYY-MM-DD + HH:MM:SS uses UTC. + type: string + website_ids: + description: The website IDs the rule applies to. + items: + type: integer + type: array + type: object + catalog-price-rule-api-data-catalog-price-rule-search-result-interface: + description: Search results for catalog price rule list operations. + properties: + items: + description: The catalog price rules. + items: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + type: array + search_criteria: + "$ref": "#/definitions/framework-search-criteria-interface" + total_count: + description: Total count. + type: integer + required: + - items + - search_criteria + - total_count + type: object + catalog-price-rule-api-data-condition-attribute-interface: + description: Describes one attribute usable in a rule condition, plus how to fetch + its values. + properties: + attribute_code: + description: The attribute code. + type: string + input_type: + description: The input type (e.g. text, select, multiselect, boolean, date). + type: string + label: + description: The human-readable label. + type: string + operators: + description: The operators valid for this attribute. + items: + type: string + type: array + value_source: + description: The endpoint/hint a client uses to fetch valid values (null for + free text). + type: string + type: object + catalog-price-rule-api-data-condition-item-interface: + description: 'A condition node: a leaf (attribute/operator/value) or a nested + group (aggregator over children).' + properties: + aggregator: + description: The aggregator when this node is a nested group ("all" or "any"), + else null. + type: string + attribute_code: + description: The product attribute code (must be usable in catalog rules). + type: string + conditions: + description: The child nodes when this node is a nested group, else null. + items: + "$ref": "#/definitions/catalog-price-rule-api-data-condition-item-interface" + type: array + match: + description: The group truth flag (true = match when the aggregator holds, + false = negated), else null. + type: boolean + operator: + description: The comparison operator. + type: string + value: + description: The comparison value. + type: string + type: object + catalog-price-rule-api-data-metadata-interface: + description: Discovery metadata a client fetches to build a valid rule payload. + properties: + condition_attributes: + description: The attributes usable in rule conditions. + items: + "$ref": "#/definitions/catalog-price-rule-api-data-condition-attribute-interface" + type: array + simple_actions: + description: The allowed discount actions. + items: + type: string + type: array + required: + - simple_actions + - condition_attributes + type: object + catalog-price-rule-api-data-rule-condition-interface: + description: The root condition group containing leaf conditions or nested groups. + properties: + aggregator: + description: The aggregator ("all" = AND, "any" = OR). + type: string + conditions: + description: The condition items. + items: + "$ref": "#/definitions/catalog-price-rule-api-data-condition-item-interface" + type: array + match: + description: The group truth flag (true = match when the aggregator holds, + false = negated). + type: boolean + type: object catalog-product-custom-option-uid-data-option-uid-interface: description: 'A single add-to-cart UID entry for a customizable option. For selectable options (drop_down/radio/checkbox/multiple) there is one entry per value, and @@ -6203,6 +6355,8 @@ definitions: quote-data-cart-item-extension-interface: description: ExtensionInterface class for @see \Magento\Quote\Api\Data\CartItemInterface properties: + custom_price: + type: number discounts: items: "$ref": "#/definitions/sales-rule-data-rule-discount-interface" @@ -6814,6 +6968,11 @@ definitions: condition: description: Condition type: string + custom_attributes: + description: Custom attributes values. + items: + "$ref": "#/definitions/framework-attribute-interface" + type: array entity_id: description: Id type: integer @@ -10192,6 +10351,43 @@ definitions: - store_id - tax_class_id type: object + shipping-discount-api-data-shipping-discount-interface: + description: Read-only shape of an active shipping discount, as returned by ShippingDiscountManagementInterface::get(). + properties: + actor_user_id: + description: The id of the principal that applied the discount, if known. + type: integer + actor_user_type: + description: The principal type the actor_user_id value belongs to, if known. + type: integer + amount: + description: The discount amount in quote currency. + type: number + applied_amount: + description: The amount actually applied to shipping on the last totals collection + (quote currency). + type: number + base_amount: + description: The discount amount in base currency. + type: number + base_applied_amount: + description: The amount actually applied to shipping on the last totals collection + (base currency). + type: number + cart_id: + description: The cart id this discount is set on. + type: integer + reason: + description: The reason given by the caller. + type: string + required: + - cart_id + - amount + - base_amount + - applied_amount + - base_applied_amount + - reason + type: object store-data-group-extension-interface: description: ExtensionInterface class for @see \Magento\Store\Api\Data\GroupInterface type: object @@ -10877,7 +11073,7 @@ definitions: host: https://.api.commerce.adobe.com/ info: title: Adobe Commerce as a Cloud Service - version: September 2026 + version: October 2026 description: "$ref": intro/accs-intro.md paths: @@ -11091,6 +11287,60 @@ paths: tags: - adminuisdk/extension/{workspace_name}/{extension_name} summary: adminuisdk/extension/{workspace_name}/{extension_name} + "/V1/adminuisdk/extension/{workspace_name}/{extension_name}/refresh": + post: + consumes: + - application/json + - application/xml + description: Re-sync the registrations of an existing installed extension without + modifying the extension itself. + operationId: PostV1AdminuisdkExtensionWorkspace_nameExtension_nameRefresh + parameters: + - in: path + name: workspace_name + required: true + type: string + - in: path + name: extension_name + required: true + type: string + - in: body + name: PostV1AdminuisdkExtensionWorkspace_nameExtension_nameRefreshBody + schema: + properties: + extensionName: + type: string + workspaceName: + type: string + required: + - workspaceName + - extensionName + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - adminuisdk/extension/{workspace_name}/{extension_name}/refresh + summary: adminuisdk/extension/{workspace_name}/{extension_name}/refresh "/V1/adminuisdk/massaction/{request_id}": get: consumes: @@ -13712,6 +13962,118 @@ paths: tags: - carts/{cartId}/selected-payment-method summary: carts/{cartId}/selected-payment-method + "/V1/carts/{cartId}/shipping-discount": + delete: + consumes: + - application/json + - application/xml + description: 'Remove the shipping discount from the given cart, if any. Idempotent: + removing a cart with no discount set is a no-op, not an error.' + operationId: DeleteV1CartsCartIdShippingdiscount + parameters: + - in: path + name: cartId + required: true + type: integer + produces: + - application/json + - application/xml + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - carts/{cartId}/shipping-discount + summary: carts/{cartId}/shipping-discount + get: + consumes: + - application/json + - application/xml + description: Get the active shipping discount on the given cart. + operationId: GetV1CartsCartIdShippingdiscount + parameters: + - in: path + name: cartId + required: true + type: integer + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/shipping-discount-api-data-shipping-discount-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - carts/{cartId}/shipping-discount + summary: carts/{cartId}/shipping-discount + post: + consumes: + - application/json + - application/xml + description: Set (or replace) the shipping discount on the given cart. + operationId: PostV1CartsCartIdShippingdiscount + parameters: + - in: path + name: cartId + required: true + type: integer + - in: body + name: PostV1CartsCartIdShippingdiscountBody + schema: + properties: + amount: + description: Discount amount, in the cart's quote currency (not base + currency - see ShippingDiscountManagement::convertToBaseCurrency()) + type: number + reason: + type: string + required: + - amount + - reason + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - carts/{cartId}/shipping-discount + summary: carts/{cartId}/shipping-discount "/V1/carts/{cartId}/shipping-information": post: consumes: @@ -13948,6 +14310,251 @@ paths: tags: - carts/{quoteId}/items summary: carts/{quoteId}/items + "/V1/catalogPriceRules": + post: + consumes: + - application/json + - application/xml + description: Create a new catalog price rule. Rules are created inactive unless + is_active is explicitly set, so a bulk import cannot reprice the catalog before + the payload has been reviewed. + operationId: PostV1CatalogPriceRules + parameters: + - in: body + name: PostV1CatalogPriceRulesBody + schema: + properties: + rule: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + required: + - rule + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules + summary: catalogPriceRules + "/V1/catalogPriceRules/metadata": + get: + consumes: + - application/json + - application/xml + description: Retrieve the discovery metadata for building a valid rule payload. + Returns the allowed discount actions and the attributes usable in conditions. + operationId: GetV1CatalogPriceRulesMetadata + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-price-rule-api-data-metadata-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules/metadata + summary: catalogPriceRules/metadata + "/V1/catalogPriceRules/search": + get: + consumes: + - application/json + - application/xml + description: Retrieve catalog price rules matching the search criteria. + operationId: GetV1CatalogPriceRulesSearch + parameters: + - description: Field + in: query + name: searchCriteria[filterGroups][0][filters][0][field] + type: string + - description: Value + in: query + name: searchCriteria[filterGroups][0][filters][0][value] + type: string + - description: Condition type + in: query + name: searchCriteria[filterGroups][0][filters][0][conditionType] + type: string + - description: Sorting field. + in: query + name: searchCriteria[sortOrders][0][field] + type: string + - description: Sorting direction. + in: query + name: searchCriteria[sortOrders][0][direction] + type: string + - description: Page size. + in: query + name: searchCriteria[pageSize] + type: integer + - description: Current page. + in: query + name: searchCriteria[currentPage] + type: integer + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules/search + summary: catalogPriceRules/search + "/V1/catalogPriceRules/{ruleId}": + delete: + consumes: + - application/json + - application/xml + description: Delete a catalog price rule by ID. + operationId: DeleteV1CatalogPriceRulesRuleId + parameters: + - in: path + name: ruleId + required: true + type: integer + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + type: boolean + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules/{ruleId} + summary: catalogPriceRules/{ruleId} + get: + consumes: + - application/json + - application/xml + description: Retrieve a catalog price rule by ID. + operationId: GetV1CatalogPriceRulesRuleId + parameters: + - in: path + name: ruleId + required: true + type: integer + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules/{ruleId} + summary: catalogPriceRules/{ruleId} + put: + consumes: + - application/json + - application/xml + description: Update an existing catalog price rule (only provided fields are + applied). + operationId: PutV1CatalogPriceRulesRuleId + parameters: + - in: path + name: ruleId + required: true + type: integer + - in: body + name: PutV1CatalogPriceRulesRuleIdBody + schema: + properties: + rule: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + required: + - rule + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/catalog-price-rule-api-data-catalog-price-rule-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + '500': + description: Internal Server error + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - catalogPriceRules/{ruleId} + summary: catalogPriceRules/{ruleId} "/V1/categories": get: consumes: @@ -24912,11 +25519,11 @@ paths: - application/json - application/xml description: 'Submit an edited quote as a new order, replacing the original - order. The quote must have a payment method set before calling this (use PUT - /V1/carts/:quoteId/selected-payment-method). On success: - A new order is - created from the quote - The original order is cancelled - The two orders - are linked via relation_parent_id / relation_child_id - The new order gets - an increment ID of the form {originalIncrement}-{n}' + order. The payment method is inherited from the original order. Only call + PUT /V1/carts/:quoteId/selected-payment-method beforehand if you want to override + it. On success: - A new order is created from the quote - The original + order is cancelled - The two orders are linked via relation_parent_id / + relation_child_id - The new order gets an increment ID of the form {originalIncrement}-{n}' operationId: PostV1OrdersOrderIdEditSubmit parameters: - description: The original order being edited @@ -32041,6 +32648,7 @@ tags: - name: adminuisdk/config - name: adminuisdk/extension - name: adminuisdk/extension/{workspace_name}/{extension_name} +- name: adminuisdk/extension/{workspace_name}/{extension_name}/refresh - name: adminuisdk/massaction/{request_id} - name: adminuisdk/orderviewbutton/{request_id} - name: adminuisdk/permission/check @@ -32094,6 +32702,7 @@ tags: - name: carts/{cartId}/order - name: carts/{cartId}/payment-methods - name: carts/{cartId}/selected-payment-method +- name: carts/{cartId}/shipping-discount - name: carts/{cartId}/shipping-information - name: carts/{cartId}/shipping-methods - name: carts/{cartId}/totals @@ -32103,6 +32712,10 @@ tags: - name: carts/licence - name: carts/licence/list - name: carts/search +- name: catalogPriceRules +- name: catalogPriceRules/{ruleId} +- name: catalogPriceRules/metadata +- name: catalogPriceRules/search - name: categories - name: categories/{categoryId} - name: categories/{categoryId}/move @@ -32448,6 +33061,7 @@ x-tagGroups: - adminuisdk/config - adminuisdk/extension - adminuisdk/extension/{workspace_name}/{extension_name} + - adminuisdk/extension/{workspace_name}/{extension_name}/refresh - adminuisdk/massaction/{request_id} - adminuisdk/orderviewbutton/{request_id} - adminuisdk/permission/check @@ -32516,12 +33130,19 @@ x-tagGroups: - carts/{cartId}/order - carts/{cartId}/payment-methods - carts/{cartId}/selected-payment-method + - carts/{cartId}/shipping-discount - carts/{cartId}/shipping-information - carts/{cartId}/shipping-methods - carts/{cartId}/totals - carts/{cartId}/totals-information - carts/{quoteId}/giftCards - carts/{quoteId}/items +- name: catalogPriceRules + tags: + - catalogPriceRules + - catalogPriceRules/metadata + - catalogPriceRules/search + - catalogPriceRules/{ruleId} - name: categories tags: - categories diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index ceee81245..345d77ce9 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -33,7 +33,7 @@ mutation acceptCompanyInvitation($input: CompanyInvitationInput!) { ##### Response ```json -{"data": {"acceptCompanyInvitation": {"success": false}}} +{"data": {"acceptCompanyInvitation": {"success": true}}} ``` @@ -120,9 +120,9 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 123, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -135,10 +135,10 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": "4", + "template_id": 4, "total_quantity": 123.45, - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } } } @@ -227,7 +227,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -350,7 +350,7 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": "4" } @@ -505,7 +505,10 @@ mutation addProductsToWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} +{ + "wishlistId": "4", + "wishlistItems": [WishlistItemInput] +} ``` ##### Response @@ -523,6 +526,56 @@ mutation addProductsToWishlist( +### addPublicRequisitionListItemsToCart + +Add items from a public requisition list (identified by token) to a cart. Does not require authentication; guests must supply a cart_id obtained via createGuestCart. Omit item_uids to add every item in the list. + +**Response:** [`AddPublicRequisitionListItemsToCartOutput`](/reference/graphql/saas/types-a-b.md#addpublicrequisitionlistitemstocartoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`AddPublicRequisitionListItemsToCartInput!`](/reference/graphql/saas/types-a-b.md#addpublicrequisitionlistitemstocartinput) | | + +#### Example + +##### Query + +```graphql +mutation addPublicRequisitionListItemsToCart($input: AddPublicRequisitionListItemsToCartInput!) { + addPublicRequisitionListItemsToCart(input: $input) { + cart { + ...CartFragment + } + user_errors { + ...PublicRequisitionListUserErrorFragment + } + } +} +``` + +##### Variables + +```json +{"input": AddPublicRequisitionListItemsToCartInput} +``` + +##### Response + +```json +{ + "data": { + "addPublicRequisitionListItemsToCart": { + "cart": Cart, + "user_errors": [PublicRequisitionListUserError] + } + } +} +``` + + + ### addPurchaseOrderComment Add a comment to an existing purchase order. @@ -659,7 +712,10 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{"requisitionListUid": 4, "requisitionListItemUids": [4]} +{ + "requisitionListUid": "4", + "requisitionListItemUids": [4] +} ``` ##### Response @@ -810,7 +866,10 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{"wishlistId": "4", "wishlistItemIds": [4]} +{ + "wishlistId": "4", + "wishlistItemIds": ["4"] +} ``` ##### Response @@ -980,7 +1039,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": "4"} +{"cartId": 4} ``` ##### Response @@ -1157,7 +1216,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -1276,20 +1335,20 @@ mutation assignCustomerToGuestCart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, "has_available_free_gifts": false, "id": "4", "is_virtual": true, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": false, + "printed_card_included": true, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], - "total_quantity": 123.45 + "total_quantity": 987.65 } } } @@ -1374,16 +1433,16 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "cancelNegotiableQuoteTemplate": { "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": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -1393,11 +1452,11 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": 4, - "total_quantity": 987.65, - "uid": "4", - "updated_at": "abc123" + "total_quantity": 123.45, + "uid": 4, + "updated_at": "xyz789" } } } @@ -1447,7 +1506,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1658,7 +1717,7 @@ mutation changeCustomerPassword( "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, @@ -1667,18 +1726,18 @@ mutation changeCustomerPassword( "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", - "email": "xyz789", + "default_shipping": "xyz789", + "email": "abc123", "firstname": "abc123", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", - "is_subscribed": true, + "is_subscribed": false, "job_title": "xyz789", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1686,7 +1745,7 @@ mutation changeCustomerPassword( "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, @@ -1697,11 +1756,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": "4", + "structure_id": 4, "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "abc123", + "telephone": "xyz789", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1791,7 +1850,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "xyz789"} +{"cartUid": "abc123"} ``` ##### Response @@ -2007,7 +2066,7 @@ mutation confirmCancelOrder($input: ConfirmCancelOrderInput!) { { "data": { "confirmCancelOrder": { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -2186,7 +2245,7 @@ mutation copyItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2251,7 +2310,7 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": "4", "wishlistItems": [WishlistItemCopyInput] } @@ -2378,26 +2437,26 @@ mutation createCompanyAddress($input: CompanyAddressInput!) { "createCompanyAddress": { "address_type": "BILLING", "city": "xyz789", - "company": "xyz789", - "company_id": "4", + "company": "abc123", + "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", + "fax": "abc123", + "firstname": "xyz789", "id": "4", - "is_default": true, - "lastname": "xyz789", - "middlename": "abc123", - "nickname": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "is_default": false, + "lastname": "abc123", + "middlename": "xyz789", + "nickname": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" + "telephone": "abc123", + "vat_id": "abc123" } } } @@ -2571,7 +2630,7 @@ mutation createCompareList($input: CreateCompareListInput) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -2641,27 +2700,27 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { { "data": { "createCustomerAddress": { - "city": "abc123", + "city": "xyz789", "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 987, "street": ["abc123"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "xyz789", "uid": 4, - "vat_id": "abc123" + "vat_id": "xyz789" } } } @@ -2831,7 +2890,7 @@ mutation createPaymentLink( ```json { "cartId": "abc123", - "recipientEmail": "xyz789" + "recipientEmail": "abc123" } ``` @@ -2841,9 +2900,9 @@ mutation createPaymentLink( { "data": { "createPaymentLink": { - "expiresAt": "xyz789", + "expiresAt": "abc123", "payUrl": "xyz789", - "token": "abc123" + "token": "xyz789" } } } @@ -2891,10 +2950,10 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { { "data": { "createPaymentOrder": { - "amount": 123.45, - "currency_code": "abc123", + "amount": 987.65, + "currency_code": "xyz789", "id": "abc123", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "status": "abc123" } } @@ -3002,12 +3061,12 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "xyz789", + "created_by": "abc123", "description": "abc123", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -3101,7 +3160,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } } } @@ -3256,13 +3315,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": true}}} +{"data": {"deleteCompanyRole": {"success": false}}} ``` @@ -3332,7 +3391,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": "4"} +{"id": 4} ``` ##### Response @@ -3376,7 +3435,7 @@ mutation deleteCompareList($uid: ID!) { ##### Response ```json -{"data": {"deleteCompareList": {"result": true}}} +{"data": {"deleteCompareList": {"result": false}}} ``` @@ -3400,7 +3459,7 @@ mutation deleteCustomer { ##### Response ```json -{"data": {"deleteCustomer": false}} +{"data": {"deleteCustomer": true}} ``` @@ -3434,7 +3493,7 @@ mutation deleteCustomerAddress($id: Int!) { ##### Variables ```json -{"id": 123} +{"id": 987} ``` ##### Response @@ -3470,13 +3529,13 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCustomerAddressV2": true}} +{"data": {"deleteCustomerAddressV2": false}} ``` @@ -3616,7 +3675,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } } } @@ -3700,7 +3759,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -3710,7 +3769,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { "data": { "deleteRequisitionList": { "requisition_lists": RequisitionLists, - "status": true + "status": false } } } @@ -3756,7 +3815,7 @@ mutation deleteRequisitionListItems( ```json { "requisitionListUid": "4", - "requisitionListItemUids": ["4"] + "requisitionListItemUids": [4] } ``` @@ -3813,7 +3872,7 @@ mutation deleteWishlist($wishlistId: ID!) { { "data": { "deleteWishlist": { - "status": false, + "status": true, "wishlists": [Wishlist] } } @@ -3922,12 +3981,12 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { { "additional_data": [ShippingAdditionalData], "amount": Money, - "available": false, - "carrier_code": "abc123", + "available": true, + "carrier_code": "xyz789", "carrier_title": "xyz789", "error_message": "abc123", "method_code": "abc123", - "method_title": "abc123", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -4061,8 +4120,8 @@ mutation exchangeOtpForCustomerToken( ```json { - "email": "xyz789", - "otp": "xyz789" + "email": "abc123", + "otp": "abc123" } ``` @@ -4117,8 +4176,8 @@ mutation finishUpload($input: finishUploadInput!) { "data": { "finishUpload": { "key": "abc123", - "message": "xyz789", - "success": false + "message": "abc123", + "success": true } } } @@ -4161,7 +4220,7 @@ mutation generateCustomerToken( ```json { - "email": "xyz789", + "email": "abc123", "password": "abc123" } ``` @@ -4172,7 +4231,7 @@ mutation generateCustomerToken( { "data": { "generateCustomerToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -4216,7 +4275,7 @@ mutation generateCustomerTokenAsAdmin($input: GenerateCustomerTokenAsAdminInput! { "data": { "generateCustomerTokenAsAdmin": { - "customer_token": "abc123" + "customer_token": "xyz789" } } } @@ -4349,7 +4408,7 @@ mutation initiateUpload($input: initiateUploadInput!) { "data": { "initiateUpload": { "expires_at": "abc123", - "key": "xyz789", + "key": "abc123", "upload_url": "abc123" } } @@ -4447,8 +4506,8 @@ mutation mergeCarts( ```json { - "source_cart_id": "xyz789", - "destination_cart_id": "abc123" + "source_cart_id": "abc123", + "destination_cart_id": "xyz789" } ``` @@ -4471,18 +4530,18 @@ mutation mergeCarts( "custom_attributes": [CustomAttribute], "email": "abc123", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": true, + "has_available_free_gifts": false, "id": 4, - "is_virtual": true, + "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": 123.45 + "total_quantity": 987.65 } } } @@ -4593,7 +4652,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": "4", + "destinationRequisitionListUid": 4, "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4705,7 +4764,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, + "sourceWishlistUid": "4", "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4804,16 +4863,16 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "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": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, "min_order_commitment": 123, - "name": "xyz789", + "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -4825,9 +4884,9 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -5110,8 +5169,8 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "data": { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, - "code": "xyz789", - "expiration_date": "xyz789" + "code": "abc123", + "expiration_date": "abc123" } } } @@ -5322,7 +5381,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Response ```json -{"data": {"removeGiftRegistry": {"success": false}}} +{"data": {"removeGiftRegistry": {"success": true}}} ``` @@ -5420,7 +5479,7 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrantsUid": ["4"] } ``` @@ -5602,30 +5661,30 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "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_min_max_qty_used": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 987, - "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", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 123.45, - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -5679,7 +5738,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -5726,7 +5785,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": "4", "wishlistItemsIds": [4]} +{"wishlistId": 4, "wishlistItemsIds": [4]} ``` ##### Response @@ -6179,16 +6238,16 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "requestNegotiableQuoteTemplateFromQuote": { "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, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "abc123", + "max_order_commitment": 123, + "min_order_commitment": 987, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -6198,11 +6257,11 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", + "status": "abc123", + "template_id": 4, "total_quantity": 123.45, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -6235,13 +6294,13 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"requestPasswordResetEmail": true}} +{"data": {"requestPasswordResetEmail": false}} ``` @@ -6321,13 +6380,13 @@ mutation resendConfirmationEmail($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"resendConfirmationEmail": false}} +{"data": {"resendConfirmationEmail": true}} ``` @@ -6369,8 +6428,8 @@ mutation resetPassword( ```json { "email": "xyz789", - "resetPasswordToken": "abc123", - "newPassword": "xyz789" + "resetPasswordToken": "xyz789", + "newPassword": "abc123" } ``` @@ -6562,7 +6621,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "abc123"} +{"cartId": "xyz789"} ``` ##### Response @@ -7000,25 +7059,25 @@ mutation setDefaultCompanyAddress($id: ID!) { "data": { "setDefaultCompanyAddress": { "address_type": "BILLING", - "city": "abc123", + "city": "xyz789", "company": "abc123", "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", "id": "4", "is_default": false, - "lastname": "xyz789", - "middlename": "abc123", - "nickname": "xyz789", + "lastname": "abc123", + "middlename": "xyz789", + "nickname": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, - "street": ["xyz789"], - "suffix": "xyz789", + "region_id": 123, + "street": ["abc123"], + "suffix": "abc123", "telephone": "abc123", "vat_id": "abc123" } @@ -7413,10 +7472,10 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], @@ -7428,11 +7487,11 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 987.65, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -7607,15 +7666,15 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "setQuoteTemplateExpirationDate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "xyz789", + "created_at": "abc123", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 123, + "max_order_commitment": 987, + "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7628,9 +7687,9 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput ], "status": "abc123", "template_id": 4, - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -7720,24 +7779,24 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 987, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": 4, + "status": "xyz789", + "template_id": "4", "total_quantity": 987.65, - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -7878,6 +7937,54 @@ mutation shareGiftRegistry( +### sharePublicRequisitionList + +Email the requisition list's public share link (existing token, reused) to one or more email addresses. Fails with a user error if the list has not been marked public. Only the list owner may call this mutation. + +**Response:** [`SharePublicRequisitionListOutput`](/reference/graphql/saas/types-q-s.md#sharepublicrequisitionlistoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `input` - [`SharePublicRequisitionListInput!`](/reference/graphql/saas/types-q-s.md#sharepublicrequisitionlistinput) | | + +#### Example + +##### Query + +```graphql +mutation sharePublicRequisitionList($input: SharePublicRequisitionListInput!) { + sharePublicRequisitionList(input: $input) { + sent_count + user_errors { + ...PublicRequisitionListUserErrorFragment + } + } +} +``` + +##### Variables + +```json +{"input": SharePublicRequisitionListInput} +``` + +##### Response + +```json +{ + "data": { + "sharePublicRequisitionList": { + "sent_count": 123, + "user_errors": [PublicRequisitionListUserError] + } + } +} +``` + + + ### shareRequisitionListByEmail Share a requisition list with company colleagues via email using a secure link. @@ -7917,7 +8024,7 @@ mutation shareRequisitionListByEmail($input: ShareRequisitionListByEmailInput!) { "data": { "shareRequisitionListByEmail": { - "sent_count": 123, + "sent_count": 987, "user_errors": [ShareRequisitionListUserError] } } @@ -7953,7 +8060,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": "4"} +{"requisitionListUid": 4} ``` ##### Response @@ -7962,7 +8069,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { { "data": { "shareRequisitionListByToken": { - "token": "abc123" + "token": "xyz789" } } } @@ -8047,14 +8154,14 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "submitNegotiableQuoteTemplateForReview": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", + "created_at": "xyz789", "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, + "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -8067,9 +8174,9 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": 4, + "template_id": "4", "total_quantity": 987.65, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -8105,7 +8212,7 @@ mutation subscribeEmailToNewsletter($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -8153,7 +8260,7 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "subscribeProductAlertPrice": { - "message": "xyz789", + "message": "abc123", "success": true } } @@ -8199,8 +8306,8 @@ mutation subscribeProductAlertStock($input: ProductAlertStockInput!) { { "data": { "subscribeProductAlertStock": { - "message": "xyz789", - "success": true + "message": "abc123", + "success": false } } } @@ -8239,7 +8346,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": true}} +{"data": {"syncPaymentOrder": false}} ``` @@ -8328,7 +8435,7 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { "data": { "unsubscribeProductAlertPrice": { "message": "xyz789", - "success": false + "success": true } } } @@ -8362,7 +8469,7 @@ mutation unsubscribeProductAlertPriceAll { "data": { "unsubscribeProductAlertPriceAll": { "message": "xyz789", - "success": true + "success": false } } } @@ -8408,7 +8515,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { "data": { "unsubscribeProductAlertStock": { "message": "xyz789", - "success": false + "success": true } } } @@ -8441,8 +8548,8 @@ mutation unsubscribeProductAlertStockAll { { "data": { "unsubscribeProductAlertStockAll": { - "message": "xyz789", - "success": false + "message": "abc123", + "success": true } } } @@ -8601,10 +8708,7 @@ mutation updateCompanyAddress( ##### Variables ```json -{ - "id": "4", - "input": CompanyAddressUpdateInput -} +{"id": 4, "input": CompanyAddressUpdateInput} ``` ##### Response @@ -8614,25 +8718,25 @@ mutation updateCompanyAddress( "data": { "updateCompanyAddress": { "address_type": "BILLING", - "city": "abc123", - "company": "abc123", - "company_id": 4, + "city": "xyz789", + "company": "xyz789", + "company_id": "4", "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", "id": "4", - "is_default": true, + "is_default": false, "lastname": "xyz789", "middlename": "xyz789", - "nickname": "xyz789", + "nickname": "abc123", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 123, - "street": ["abc123"], - "suffix": "xyz789", + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", "vat_id": "xyz789" } @@ -8915,8 +9019,8 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": true, @@ -8927,15 +9031,15 @@ mutation updateCustomerAddress( "id": 987, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "uid": 4, - "vat_id": "xyz789" + "suffix": "abc123", + "telephone": "xyz789", + "uid": "4", + "vat_id": "abc123" } } } @@ -9003,7 +9107,10 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{"uid": 4, "input": CustomerAddressInput} +{ + "uid": "4", + "input": CustomerAddressInput +} ``` ##### Response @@ -9017,20 +9124,20 @@ mutation updateCustomerAddressV2( "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": false, + "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", - "id": 987, - "lastname": "abc123", + "id": 123, + "lastname": "xyz789", "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "xyz789", "uid": 4, "vat_id": "xyz789" } @@ -9077,7 +9184,7 @@ mutation updateCustomerEmail( ```json { - "email": "abc123", + "email": "xyz789", "password": "xyz789" } ``` @@ -9167,7 +9274,7 @@ mutation updateGiftRegistry( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "giftRegistry": UpdateGiftRegistryInput } ``` @@ -9221,7 +9328,7 @@ mutation updateGiftRegistryItems( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "items": [UpdateGiftRegistryItemInput] } ``` @@ -9277,7 +9384,7 @@ mutation updateGiftRegistryRegistrants( ```json { - "giftRegistryUid": "4", + "giftRegistryUid": 4, "registrants": [UpdateGiftRegistryRegistrantInput] } ``` @@ -9505,9 +9612,9 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "created_at": "xyz789", "created_by": "abc123", "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": "4", + "uid": 4, "updated_at": "abc123" } } @@ -9553,7 +9660,7 @@ mutation updateRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "input": UpdateRequisitionListInput } ``` @@ -9670,7 +9777,7 @@ mutation updateWishlist( ```json { - "wishlistId": "4", + "wishlistId": 4, "name": "abc123", "visibility": "PUBLIC" } @@ -9682,8 +9789,8 @@ mutation updateWishlist( { "data": { "updateWishlist": { - "name": "abc123", - "uid": "4", + "name": "xyz789", + "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 dcf118ba2..b48b42848 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -86,7 +86,7 @@ query attributesForm($formCode: String!) { ##### Variables ```json -{"formCode": "abc123"} +{"formCode": "xyz789"} ``` ##### Response @@ -296,6 +296,10 @@ query availableStores($useCurrentGroup: Boolean) { quote_minimum_amount quote_minimum_amount_message required_character_classes_number + requisition_list_public_share_link_validity_days + requisition_list_public_share_max_recipients + requisition_list_public_share_storefront_path + requisition_list_public_sharing_enabled requisition_list_share_link_validity_days requisition_list_share_max_recipients requisition_list_share_storefront_path @@ -358,116 +362,120 @@ 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_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": false, "base_currency_code": "xyz789", - "base_link_url": "xyz789", + "base_link_url": "abc123", "base_media_url": "abc123", - "base_static_url": "abc123", - "base_url": "abc123", + "base_static_url": "xyz789", + "base_url": "xyz789", "cart_expires_in_days": 123, "cart_gift_wrapping": "xyz789", "cart_merge_preference": "abc123", "cart_printed_card": "abc123", "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "abc123", + "catalog_default_sort_by": "xyz789", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": false, + "check_money_order_enabled": true, "check_money_order_make_check_payable_to": "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": "abc123", - "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 123, - "check_money_order_title": "xyz789", + "check_money_order_send_check_to": "xyz789", + "check_money_order_sort_order": 987, + "check_money_order_title": "abc123", "company_credit_enabled": true, - "company_enabled": true, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", "contact_enabled": false, - "countries_with_required_region": "abc123", - "create_account_confirmation": true, + "countries_with_required_region": "xyz789", + "create_account_confirmation": false, "customer_access_token_lifetime": 987.65, "default_country": "xyz789", "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 123, + "display_product_prices_in_catalog": 987, "display_shipping_prices": 987, "display_state_if_optional": false, "enable_multiple_wishlists": "abc123", "fixed_product_taxes_apply_tax_to_fpt": false, "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 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": 123, - "fixed_product_taxes_enable": true, + "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": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": false, - "is_default_store_group": true, + "is_default_store_group": false, "is_guest_checkout_enabled": true, "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": false, - "is_requisition_list_active": "abc123", + "is_one_page_checkout_enabled": true, + "is_requisition_list_active": "xyz789", "list_mode": "abc123", "list_per_page": 987, - "list_per_page_values": "abc123", - "locale": "abc123", - "magento_reward_general_is_enabled": "xyz789", + "list_per_page_values": "xyz789", + "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_min_points_balance": "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_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "abc123", "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", "magento_reward_points_review": "xyz789", - "magento_reward_points_review_limit": "abc123", + "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "abc123", - "minicart_display": true, + "maximum_number_of_wishlists": "xyz789", + "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "abc123", - "newsletter_enabled": false, + "minimum_password_length": "xyz789", + "newsletter_enabled": true, "optional_zip_countries": "xyz789", "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], - "orders_invoices_credit_memos_display_full_summary": false, - "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 987, - "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_full_summary": true, + "orders_invoices_credit_memos_display_grandtotal": false, + "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_zero_tax": false, + "orders_invoices_credit_memos_display_zero_tax": true, "persistent_enabled": true, "persistent_options_wishlist": false, "persistent_shopping_cart": false, "printed_card_priceV2": Money, "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "product_reviews_enabled": "xyz789", - "product_url_suffix": "xyz789", + "product_reviews_enabled": "abc123", + "product_url_suffix": "abc123", "quickorder_active": true, - "quote_minimum_amount": 987.65, - "quote_minimum_amount_message": "abc123", - "required_character_classes_number": "xyz789", + "quote_minimum_amount": 123.45, + "quote_minimum_amount_message": "xyz789", + "required_character_classes_number": "abc123", + "requisition_list_public_share_link_validity_days": 123, + "requisition_list_public_share_max_recipients": 123, + "requisition_list_public_share_storefront_path": "xyz789", + "requisition_list_public_sharing_enabled": false, "requisition_list_share_link_validity_days": 987, "requisition_list_share_max_recipients": 987, "requisition_list_share_storefront_path": "abc123", @@ -477,28 +485,28 @@ query availableStores($useCurrentGroup: Boolean) { "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", "sales_printed_card": "xyz789", - "secure_base_link_url": "abc123", + "secure_base_link_url": "xyz789", "secure_base_media_url": "xyz789", - "secure_base_static_url": "abc123", + "secure_base_static_url": "xyz789", "secure_base_url": "xyz789", "share_active_segments": false, "share_applied_cart_rule": true, "share_customer_accounts_scope": 123, "shopping_assistance_checkbox_title": "abc123", - "shopping_assistance_checkbox_tooltip": "xyz789", + "shopping_assistance_checkbox_tooltip": "abc123", "shopping_assistance_enabled": true, "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": false, - "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 123, + "shopping_cart_display_grand_total": true, + "shopping_cart_display_price": 987, + "shopping_cart_display_shipping": 987, "shopping_cart_display_subtotal": 123, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "store_code": 4, "store_group_code": 4, "store_group_name": "abc123", - "store_name": "abc123", - "store_sort_order": 123, + "store_name": "xyz789", + "store_sort_order": 987, "timezone": "xyz789", "title_separator": "xyz789", "use_store_in_url": true, @@ -507,11 +515,11 @@ query availableStores($useCurrentGroup: Boolean) { "weight_unit": "xyz789", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_new_order_status": "xyz789", + "zero_subtotal_payment_action": "abc123", "zero_subtotal_payment_from_specific_countries": "abc123", "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "xyz789" + "zero_subtotal_title": "abc123" } ] } @@ -621,20 +629,20 @@ query cart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": false, - "id": 4, - "is_virtual": false, + "has_available_free_gifts": true, + "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": 123.45 + "total_quantity": 987.65 } } } @@ -693,7 +701,7 @@ query categories( ```json { - "ids": ["abc123"], + "ids": ["xyz789"], "roles": ["abc123"], "subtree": Subtree } @@ -706,20 +714,20 @@ query categories( "data": { "categories": [ { - "availableSortBy": ["xyz789"], + "availableSortBy": ["abc123"], "children": ["xyz789"], - "defaultSortBy": "xyz789", - "id": "4", - "level": 987, - "name": "abc123", - "parentId": "xyz789", + "defaultSortBy": "abc123", + "id": 4, + "level": 123, + "name": "xyz789", + "parentId": "abc123", "position": 123, "path": "xyz789", - "roles": ["xyz789"], - "urlKey": "xyz789", - "urlPath": "xyz789", - "count": 123, - "title": "abc123" + "roles": ["abc123"], + "urlKey": "abc123", + "urlPath": "abc123", + "count": 987, + "title": "xyz789" } ] } @@ -759,13 +767,13 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 123, - "checkbox_text": "xyz789", + "agreement_id": 987, + "checkbox_text": "abc123", "content": "xyz789", - "content_height": "abc123", - "is_html": false, + "content_height": "xyz789", + "is_html": true, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ] } @@ -903,13 +911,13 @@ query company { "custom_attributes": [CustomAttribute], "default_billing_address": CompanyAddress, "default_shipping_address": CompanyAddress, - "email": "abc123", - "id": "4", + "email": "xyz789", + "id": 4, "legal_address": CompanyLegalAddress, - "legal_name": "abc123", + "legal_name": "xyz789", "name": "abc123", "payment_methods": ["xyz789"], - "reseller_id": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -918,7 +926,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } } } @@ -960,7 +968,7 @@ query compareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -972,7 +980,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": 4 + "uid": "4" } } } @@ -1013,10 +1021,10 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", - "id": "abc123", - "three_letter_abbreviation": "xyz789", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", + "id": "xyz789", + "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "xyz789" } ] @@ -1060,7 +1068,7 @@ query country($id: String) { ##### Variables ```json -{"id": "abc123"} +{"id": "xyz789"} ``` ##### Response @@ -1070,8 +1078,8 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "abc123", + "full_name_english": "abc123", + "full_name_locale": "xyz789", "id": "xyz789", "three_letter_abbreviation": "xyz789", "two_letter_abbreviation": "xyz789" @@ -1114,12 +1122,12 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "abc123" + "xyz789" ], - "base_currency_code": "abc123", + "base_currency_code": "xyz789", "base_currency_symbol": "xyz789", - "default_display_currency_code": "xyz789", - "default_display_currency_symbol": "abc123", + "default_display_currency_code": "abc123", + "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] } } @@ -1307,27 +1315,27 @@ query customer { "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", "created_at": "abc123", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", + "date_of_birth": "abc123", + "default_billing": "abc123", "default_shipping": "xyz789", - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "gender": 123, + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": "4", + "id": 4, "is_subscribed": false, - "job_title": "xyz789", - "lastname": "xyz789", - "middlename": "abc123", + "job_title": "abc123", + "lastname": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, "prefix": "xyz789", "purchase_order": PurchaseOrder, @@ -1336,7 +1344,7 @@ query customer { "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, "purchase_orders_enabled": true, - "quote_enabled": false, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1347,8 +1355,8 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "xyz789", - "taxvat": "xyz789", + "suffix": "abc123", + "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", "wishlist_v2": Wishlist, @@ -1449,16 +1457,16 @@ query customerCart { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "abc123", + "email": "xyz789", "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": false, - "id": 4, + "has_available_free_gifts": true, + "id": "4", "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, - "printed_card_included": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -1706,8 +1714,8 @@ query getPaymentOrder( ```json { - "cartId": "abc123", - "id": "abc123" + "cartId": "xyz789", + "id": "xyz789" } ``` @@ -1904,7 +1912,7 @@ query giftRegistry($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": "4"} +{"giftRegistryUid": 4} ``` ##### Response @@ -1913,14 +1921,14 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], - "event_name": "abc123", + "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "xyz789", - "owner_name": "xyz789", + "message": "abc123", + "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, @@ -1966,7 +1974,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -1976,12 +1984,12 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": 4, + "event_date": "abc123", + "event_title": "abc123", + "gift_registry_uid": "4", "location": "abc123", - "name": "xyz789", - "type": "abc123" + "name": "abc123", + "type": "xyz789" } ] } @@ -2035,9 +2043,9 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "event_date": "xyz789", "event_title": "xyz789", "gift_registry_uid": 4, - "location": "abc123", + "location": "xyz789", "name": "xyz789", - "type": "abc123" + "type": "xyz789" } ] } @@ -2089,9 +2097,9 @@ query giftRegistryTypeSearch( ```json { - "firstName": "abc123", - "lastName": "xyz789", - "giftRegistryTypeUid": 4 + "firstName": "xyz789", + "lastName": "abc123", + "giftRegistryTypeUid": "4" } ``` @@ -2102,12 +2110,12 @@ query giftRegistryTypeSearch( "data": { "giftRegistryTypeSearch": [ { - "event_date": "abc123", + "event_date": "xyz789", "event_title": "abc123", "gift_registry_uid": 4, - "location": "xyz789", + "location": "abc123", "name": "abc123", - "type": "xyz789" + "type": "abc123" } ] } @@ -2148,7 +2156,7 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", + "label": "abc123", "uid": "4" } ] @@ -2275,23 +2283,23 @@ query guestOrder($input: GuestOrderInformationInput!) { "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, "number": "xyz789", - "order_date": "xyz789", + "order_date": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", - "token": "xyz789", + "shipping_method": "abc123", + "status": "abc123", + "token": "abc123", "total": OrderTotal } } @@ -2408,32 +2416,32 @@ query guestOrderByToken($input: OrderTokenInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "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": false, + "is_virtual": true, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "abc123", - "order_date": "abc123", + "number": "xyz789", + "order_date": "xyz789", "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], - "printed_card_included": true, + "printed_card_included": false, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", + "shipping_method": "xyz789", "status": "xyz789", - "token": "abc123", + "token": "xyz789", "total": OrderTotal } } @@ -2475,7 +2483,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} ``` @@ -2507,7 +2515,7 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2551,7 +2559,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} ``` @@ -2583,7 +2591,7 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2669,8 +2677,8 @@ query isSubscribedProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "isSubscribedProductAlertPrice": { - "isSubscribed": false, - "message": "abc123" + "isSubscribed": true, + "message": "xyz789" } } } @@ -2716,7 +2724,7 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { "data": { "isSubscribedProductAlertStock": { "isSubscribed": true, - "message": "xyz789" + "message": "abc123" } } } @@ -2795,7 +2803,7 @@ query negotiableQuote($uid: ID!) { ##### Variables ```json -{"uid": "4"} +{"uid": 4} ``` ##### Response @@ -2813,24 +2821,24 @@ query negotiableQuote($uid: ID!) { "created_at": "xyz789", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "is_virtual": true, "items": [CartItemInterface], - "name": "abc123", + "name": "xyz789", "order": CustomerOrder, "prices": CartPrices, - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "template_id": 4, + "template_id": "4", "template_name": "xyz789", - "total_quantity": 987.65, + "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -2904,7 +2912,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": "4"} +{"templateId": 4} ``` ##### Response @@ -2919,12 +2927,12 @@ query negotiableQuoteTemplate($templateId: ID!) { "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": true, - "is_virtual": false, + "is_min_max_qty_used": false, + "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 987, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -2934,9 +2942,9 @@ query negotiableQuoteTemplate($templateId: ID!) { "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", + "status": "abc123", "template_id": "4", - "total_quantity": 123.45, + "total_quantity": 987.65, "uid": 4, "updated_at": "xyz789" } @@ -3330,7 +3338,7 @@ query productSearch( "items": [ProductSearchItem], "page_info": SearchResultPageInfo, "related_terms": ["xyz789"], - "suggestions": ["abc123"], + "suggestions": ["xyz789"], "total_count": 123, "warnings": [ProductSearchWarning] } @@ -3415,22 +3423,22 @@ query products($skus: [String]) { "inStock": false, "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", + "description": "xyz789", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", "metaDescription": "xyz789", "metaKeyword": "abc123", - "metaTitle": "xyz789", - "name": "xyz789", - "shortDescription": "abc123", + "metaTitle": "abc123", + "name": "abc123", + "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], - "sku": "abc123", - "externalId": "xyz789", + "sku": "xyz789", + "externalId": "abc123", "externalIds": [ExternalId], - "url": "abc123", - "urlKey": "xyz789", + "url": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], "queryType": "abc123", "visibility": "abc123" @@ -3442,6 +3450,54 @@ query products($skus: [String]) { +### publicRequisitionList + +Return a requisition list marked public, identified by its token. Throws a GraphQL error if the token is invalid or the list is no longer public. Does not require authentication. + +**Response:** [`PublicRequisitionListOutput`](/reference/graphql/saas/types-k-p.md#publicrequisitionlistoutput) + +#### Arguments + +| Name | Description | +|------|-------------| +| `token` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The public token identifying the requisition list. | + +#### Example + +##### Query + +```graphql +query publicRequisitionList($token: ID!) { + publicRequisitionList(token: $token) { + requisition_list { + ...RequisitionListFragment + } + sender_name + } +} +``` + +##### Variables + +```json +{"token": 4} +``` + +##### Response + +```json +{ + "data": { + "publicRequisitionList": { + "requisition_list": RequisitionList, + "sender_name": "abc123" + } + } +} +``` + + + ### recaptchaFormConfig **Response:** [`ReCaptchaConfigOutput`](/reference/graphql/saas/types-q-s.md#recaptchaconfigoutput) @@ -3480,7 +3536,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": false + "is_enabled": true } } } @@ -3574,7 +3630,7 @@ query recaptchaV3Config { "badge_position": "abc123", "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": false, + "is_enabled": true, "language_code": "xyz789", "minimum_score": 987.65, "theme": "abc123", @@ -3644,7 +3700,7 @@ query recommendations( { "cartSkus": ["xyz789"], "category": "xyz789", - "currentSku": "abc123", + "currentSku": "xyz789", "currentProduct": CurrentProductInput, "pageType": "CMS", "userPurchaseHistory": [PurchaseHistory], @@ -3660,7 +3716,7 @@ query recommendations( "data": { "recommendations": { "results": [RecommendationUnit], - "totalResults": 123 + "totalResults": 987 } } } @@ -3721,7 +3777,7 @@ query recommendationsByUnits( "currentProduct": CurrentProductInput, "userPurchaseHistory": [PurchaseHistory], "userViewHistory": [ViewHistory], - "cartSkus": ["abc123"] + "cartSkus": ["xyz789"] } ``` @@ -3821,28 +3877,92 @@ query refineProduct( "data": { "refineProduct": { "addToCartAllowed": false, - "inStock": true, - "lowStock": true, + "inStock": false, + "lowStock": false, "attributes": [ProductViewAttribute], "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", - "shortDescription": "xyz789", + "name": "abc123", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], "sku": "abc123", - "externalId": "abc123", + "externalId": "xyz789", "externalIds": [ExternalId], "url": "xyz789", - "urlKey": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "abc123", - "visibility": "xyz789" + "queryType": "xyz789", + "visibility": "abc123" + } + } +} +``` + + + +### reviews + +Return the approved reviews for the specified product SKU. Standalone root query, not a Federation extension on ProductView, since a plain root field does not need @key / _entities. + +**Response:** [`ProductReviews`](/reference/graphql/saas/types-k-p.md#productreviews) + +#### Arguments + +| Name | Description | +|------|-------------| +| `sku` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The SKU of the product to return reviews for. | +| `pageSize` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The maximum number of results to return at once. The default is 20. Default: `20` | +| `currentPage` - [`Int`](/reference/graphql/saas/types-f-i.md#int) | The page of results to return. The default is 1. Default: `1` | + +#### Example + +##### Query + +```graphql +query reviews( + $sku: String!, + $pageSize: Int, + $currentPage: Int +) { + reviews( + sku: $sku, + pageSize: $pageSize, + currentPage: $currentPage + ) { + items { + ...ProductReviewFragment + } + page_info { + ...SearchResultPageInfoFragment + } + } +} +``` + +##### Variables + +```json +{ + "sku": "xyz789", + "pageSize": 20, + "currentPage": 1 +} +``` + +##### Response + +```json +{ + "data": { + "reviews": { + "items": [ProductReview], + "page_info": SearchResultPageInfo } } } @@ -3880,7 +4000,7 @@ query sharedRequisitionList($token: String!) { ##### Variables ```json -{"token": "abc123"} +{"token": "xyz789"} ``` ##### Response @@ -3890,7 +4010,7 @@ query sharedRequisitionList($token: String!) { "data": { "sharedRequisitionList": { "requisition_list": RequisitionList, - "sender_name": "abc123" + "sender_name": "xyz789" } } } @@ -3900,7 +4020,7 @@ query sharedRequisitionList($token: String!) { ### sourceAvailability -Per-source availability for one or more SKUs, scoped to the storefront-visible sources of the current sales channel's stock. Availability is computed identically to the order-placement guard. +Per-source availability for one or more SKUs, scoped to the storefront-visible sources of the current sales channel's stock. Availability is computed identically to the order-placement guard. Only SKUs of products the shopper may see in the current website's catalog are reported. **Response:** [`[SkuSourceAvailability]!`](/reference/graphql/saas/types-q-s.md#skusourceavailability) @@ -3908,7 +4028,7 @@ Per-source availability for one or more SKUs, scoped to the storefront-visible s | Name | Description | |------|-------------| -| `skus` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | The product SKUs to report availability for. | +| `skus` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | The product SKUs to report availability for. A SKU that matches no product, whose product is not assigned to the current website or is disabled in the current store, or that the shopper's customer group may not see in the catalog (B2B shared catalog assignment or category permissions) is silently omitted from the response. | | `source_codes` - [`[String!]`](/reference/graphql/saas/types-q-s.md#string) | Restrict the report to these inventory sources. Only sources flagged storefront-visible are ever reported; a requested source that is not storefront-visible, or not assigned to the current sales channel's stock, is silently omitted. When omitted, every storefront-visible source assigned to the current sales channel's stock is reported. | | `only_in_stock` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | When true, omit sources where the SKU is not salable. | @@ -3927,6 +4047,8 @@ query sourceAvailability( source_codes: $source_codes, only_in_stock: $only_in_stock ) { + backorder_message + is_saleable sku sources { ...SourceAvailabilityFragment @@ -3940,8 +4062,8 @@ query sourceAvailability( ```json { "skus": ["abc123"], - "source_codes": ["xyz789"], - "only_in_stock": true + "source_codes": ["abc123"], + "only_in_stock": false } ``` @@ -3952,6 +4074,8 @@ query sourceAvailability( "data": { "sourceAvailability": [ { + "backorder_message": "xyz789", + "is_saleable": false, "sku": "abc123", "sources": [SourceAvailability] } @@ -4088,6 +4212,10 @@ query storeConfig { quote_minimum_amount quote_minimum_amount_message required_character_classes_number + requisition_list_public_share_link_validity_days + requisition_list_public_share_max_recipients + requisition_list_public_share_storefront_path + requisition_list_public_sharing_enabled requisition_list_share_link_validity_days requisition_list_share_max_recipients requisition_list_share_storefront_path @@ -4143,156 +4271,160 @@ query storeConfig { "data": { "storeConfig": { "allow_company_registration": false, - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "abc123", - "allow_gift_wrapping_on_order_items": "abc123", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "xyz789", + "allow_gift_wrapping_on_order_items": "xyz789", "allow_guests_to_write_product_reviews": "xyz789", "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "abc123", + "allow_printed_card": "xyz789", "autocomplete_on_storefront": true, "base_currency_code": "abc123", "base_link_url": "xyz789", "base_media_url": "abc123", - "base_static_url": "xyz789", - "base_url": "abc123", - "cart_expires_in_days": 123, - "cart_gift_wrapping": "xyz789", + "base_static_url": "abc123", + "base_url": "xyz789", + "cart_expires_in_days": 987, + "cart_gift_wrapping": "abc123", "cart_merge_preference": "xyz789", - "cart_printed_card": "xyz789", - "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "abc123", + "cart_printed_card": "abc123", + "cart_summary_display_quantity": 987, + "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": true, - "check_money_order_enabled": false, + "category_url_suffix": "abc123", + "check_money_order_enable_for_specific_countries": false, + "check_money_order_enabled": true, "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": "xyz789", - "check_money_order_sort_order": 987, + "check_money_order_payment_from_specific_countries": "abc123", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, "check_money_order_title": "xyz789", - "company_credit_enabled": true, + "company_credit_enabled": false, "company_enabled": true, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, + "contact_enabled": true, "countries_with_required_region": "xyz789", - "create_account_confirmation": true, - "customer_access_token_lifetime": 987.65, - "default_country": "xyz789", + "create_account_confirmation": false, + "customer_access_token_lifetime": 123.45, + "default_country": "abc123", "default_display_currency_code": "abc123", - "display_product_prices_in_catalog": 987, + "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": true, + "display_state_if_optional": false, "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": 987, - "fixed_product_taxes_display_prices_in_sales_modules": 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": 123, + "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_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, - "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page": 987, + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": false, + "is_checkout_agreements_enabled": true, "is_default_store": true, - "is_default_store_group": true, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": true, - "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", + "is_default_store_group": false, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": false, + "is_one_page_checkout_enabled": false, + "is_requisition_list_active": "abc123", + "list_mode": "abc123", "list_per_page": 987, - "list_per_page_values": "abc123", - "locale": "xyz789", + "list_per_page_values": "xyz789", + "locale": "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_min_points_balance": "abc123", "magento_reward_general_publish_history": "xyz789", "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "xyz789", - "magento_reward_points_invitation_order_limit": "abc123", + "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_register": "abc123", - "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "abc123", + "magento_reward_points_order": "xyz789", + "magento_reward_points_register": "xyz789", + "magento_reward_points_review": "xyz789", + "magento_reward_points_review_limit": "xyz789", "magento_wishlist_general_is_enabled": "xyz789", "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "abc123", + "maximum_number_of_wishlists": "xyz789", "minicart_display": true, - "minicart_max_items": 123, + "minicart_max_items": 987, "minimum_password_length": "xyz789", - "newsletter_enabled": true, - "optional_zip_countries": "xyz789", + "newsletter_enabled": false, + "optional_zip_countries": "abc123", "order_cancellation_enabled": false, "order_cancellation_reasons": [CancellationReason], - "orders_invoices_credit_memos_display_full_summary": false, + "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": 123, - "orders_invoices_credit_memos_display_zero_tax": false, + "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_subtotal": 987, + "orders_invoices_credit_memos_display_zero_tax": true, "persistent_enabled": false, - "persistent_options_wishlist": false, + "persistent_options_wishlist": true, "persistent_shopping_cart": false, "printed_card_priceV2": Money, - "product_alert_allow_stock": true, + "product_alert_allow_stock": false, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "abc123", "product_url_suffix": "abc123", - "quickorder_active": false, - "quote_minimum_amount": 987.65, + "quickorder_active": true, + "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "abc123", + "required_character_classes_number": "xyz789", + "requisition_list_public_share_link_validity_days": 123, + "requisition_list_public_share_max_recipients": 987, + "requisition_list_public_share_storefront_path": "abc123", + "requisition_list_public_sharing_enabled": true, "requisition_list_share_link_validity_days": 987, "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "abc123", + "requisition_list_share_storefront_path": "xyz789", "requisition_list_sharing_enabled": true, - "returns_enabled": "xyz789", - "root_category_uid": 4, + "returns_enabled": "abc123", + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", - "sales_printed_card": "xyz789", + "sales_gift_wrapping": "abc123", + "sales_printed_card": "abc123", "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "abc123", + "secure_base_static_url": "xyz789", "secure_base_url": "abc123", "share_active_segments": false, "share_applied_cart_rule": false, "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "xyz789", + "shopping_assistance_checkbox_title": "abc123", "shopping_assistance_checkbox_tooltip": "xyz789", - "shopping_assistance_enabled": false, + "shopping_assistance_enabled": true, "shopping_cart_display_full_summary": true, "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, - "shopping_cart_display_shipping": 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": true, + "shopping_cart_display_zero_tax": false, "store_code": 4, "store_group_code": 4, "store_group_name": "xyz789", "store_name": "xyz789", - "store_sort_order": 987, - "timezone": "xyz789", + "store_sort_order": 123, + "timezone": "abc123", "title_separator": "abc123", - "use_store_in_url": false, + "use_store_in_url": true, "website_code": 4, - "website_name": "abc123", + "website_name": "xyz789", "weight_unit": "abc123", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": true, - "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "abc123", - "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_payment_action": "xyz789", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 123, "zero_subtotal_title": "abc123" } @@ -4345,8 +4477,8 @@ query variants( ```json { "sku": "xyz789", - "optionIds": ["xyz789"], - "pageSize": 987, + "optionIds": ["abc123"], + "pageSize": 123, "cursor": "xyz789" } ``` @@ -4358,7 +4490,7 @@ query variants( "data": { "variants": { "variants": [ProductViewVariant], - "cursor": "xyz789" + "cursor": "abc123" } } } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md index cb35b3bd8..e02e92ec6 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-a-b.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] } ``` @@ -223,6 +223,52 @@ Contains the customer's wish list and any errors encountered. +### AddPublicRequisitionListItemsToCartInput + +An input object that identifies the public requisition list, the target cart, and which items to add. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `cart_id` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The masked ID of the target cart. Obtain a guest cart ID via the createGuestCart mutation. | +| `item_uids` - [`[ID]`](/reference/graphql/saas/types-f-i.md#id) | UIDs of specific requisition list items to add. When omitted, every item in the list is added. | +| `token` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The public token identifying the requisition list. | + +#### Example + +```json +{ + "cart_id": "xyz789", + "item_uids": ["4"], + "token": "4" +} +``` + + + +### AddPublicRequisitionListItemsToCartOutput + +Contains the updated cart and any errors encountered while adding items. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `cart` - [`Cart!`](/reference/graphql/saas/types-c-e.md#cart) | The updated cart. | +| `user_errors` - [`[PublicRequisitionListUserError]!`](/reference/graphql/saas/types-k-p.md#publicrequisitionlistusererror) | Errors encountered, e.g. NOT_PUBLIC, INVALID_TOKEN, or RESTRICTED_PRODUCT. Empty array means the operation succeeded. Items rejected as RESTRICTED_PRODUCT (outside the caller's shared catalog) are skipped rather than failing the whole request. | + +#### Example + +```json +{ + "cart": Cart, + "user_errors": [PublicRequisitionListUserError] +} +``` + + + ### AddPurchaseOrderCommentInput Contains the comment to be added to a purchase order. @@ -279,9 +325,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": true + "replace_existing_cart_items": false } ``` @@ -348,7 +394,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": false + "status": true } ``` @@ -409,7 +455,7 @@ Defines tracking information to be added to the return. { "carrier_uid": 4, "return_uid": "4", - "tracking_number": "abc123" + "tracking_number": "xyz789" } ``` @@ -578,9 +624,9 @@ Identifies the data type of the aggregation { "button_styles": ButtonStyles, "code": "xyz789", - "is_visible": true, + "is_visible": false, "payment_intent": "abc123", - "payment_source": "abc123", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "title": "abc123" @@ -605,9 +651,9 @@ Apple Pay inputs ```json { - "payment_source": "abc123", + "payment_source": "xyz789", "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "paypal_order_id": "xyz789" } ``` @@ -649,7 +695,7 @@ Contains an applied gift card with applied and remaining balance. ```json { "applied_balance": Money, - "code": "xyz789", + "code": "abc123", "current_balance": Money, "expiration_date": "xyz789" } @@ -741,7 +787,7 @@ Specifies the coupon code to apply to the cart. ```json { "cart_id": "xyz789", - "coupon_code": "abc123" + "coupon_code": "xyz789" } ``` @@ -824,7 +870,7 @@ Defines the input required to run the `applyGiftCardToCart` mutation. ```json { "cart_id": "abc123", - "gift_card_code": "xyz789" + "gift_card_code": "abc123" } ``` @@ -901,7 +947,7 @@ Defines the input required to run the `applyStoreCreditToCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -963,10 +1009,10 @@ Contains information about an asset image. ```json { "asset_image": ProductMediaGalleryEntriesAssetImage, - "disabled": false, + "disabled": true, "label": "xyz789", - "position": 987, - "types": ["xyz789"], + "position": 123, + "types": ["abc123"], "url": "xyz789" } ``` @@ -993,11 +1039,11 @@ Contains information about an asset video. ```json { "asset_video": ProductMediaGalleryEntriesAssetVideo, - "disabled": true, - "label": "xyz789", + "disabled": false, + "label": "abc123", "position": 987, - "types": ["xyz789"], - "url": "xyz789" + "types": ["abc123"], + "url": "abc123" } ``` @@ -1018,8 +1064,8 @@ Defines the input schema for assigning a child company to a parent company. ```json { - "child_company_id": "4", - "parent_company_id": 4 + "child_company_id": 4, + "parent_company_id": "4" } ``` @@ -1099,10 +1145,10 @@ List of all entity types. Populated by the modules introducing EAV entities. ```json { - "attribute_type": "xyz789", - "code": 4, - "url": "xyz789", - "value": "xyz789" + "attribute_type": "abc123", + "code": "4", + "url": "abc123", + "value": "abc123" } ``` @@ -1135,16 +1181,16 @@ An input object that specifies the filters used for attributes. { "is_comparable": true, "is_filterable": false, - "is_filterable_in_search": true, + "is_filterable_in_search": false, "is_html_allowed_on_front": false, - "is_searchable": true, - "is_used_for_customer_segment": true, + "is_searchable": false, + "is_used_for_customer_segment": false, "is_used_for_price_rules": false, "is_used_for_promo_rules": true, - "is_visible_in_advanced_search": false, - "is_visible_on_front": true, + "is_visible_in_advanced_search": true, + "is_visible_on_front": false, "is_wysiwyg_enabled": true, - "used_in_product_listing": false + "used_in_product_listing": true } ``` @@ -1198,10 +1244,10 @@ EAV attribute frontend input types. ```json { - "attribute_type": "xyz789", + "attribute_type": "abc123", "code": 4, "url": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1242,7 +1288,7 @@ Specifies selected option for a select or multiselect attribute value. #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1269,12 +1315,12 @@ Base EAV implementation of CustomAttributeMetadataInterface. ```json { - "code": "4", + "code": 4, "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", - "is_required": false, + "is_required": true, "is_unique": true, "label": "abc123", "options": [CustomAttributeOptionInterface] @@ -1298,7 +1344,7 @@ Attribute metadata retrieval error. ```json { - "message": "abc123", + "message": "xyz789", "type": "ENTITY_NOT_FOUND" } ``` @@ -1372,6 +1418,26 @@ Base EAV implementation of CustomAttributeOptionInterface. +### AttributeRangeOperatorInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attributeName` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | +| `value` - [`RangeValueInput!`](/reference/graphql/saas/types-q-s.md#rangevalueinput) | | + +#### Example + +```json +{ + "attributeName": "xyz789", + "value": RangeValueInput +} +``` + + + ### AttributeSelectedOption #### Fields @@ -1411,8 +1477,8 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -1440,6 +1506,26 @@ Base EAV implementation of CustomAttributeOptionInterface. +### AttributeStringOperatorInput + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `attributeName` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | | +| `values` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | | + +#### Example + +```json +{ + "attributeName": "xyz789", + "values": ["xyz789"] +} +``` + + + ### AttributeValue #### Fields @@ -1478,9 +1564,9 @@ Specifies the value for attribute. ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "selected_options": [AttributeInputSelectedOption], - "value": "xyz789" + "value": "abc123" } ``` @@ -1509,10 +1595,7 @@ Specifies the value for attribute. #### Example ```json -{ - "attribute_type": "xyz789", - "code": "4" -} +{"attribute_type": "xyz789", "code": 4} ``` @@ -1591,7 +1674,7 @@ Defines the code and symbol of a currency that can be used for purchase orders. #### Example ```json -{"code": "AFN", "symbol": "xyz789"} +{"code": "AFN", "symbol": "abc123"} ``` @@ -1618,7 +1701,7 @@ A free-gift cart price rule that has not yet had a gift added because the custom "gift_qty": 987, "products": [ProductInterface], "rule_id": 987, - "rule_label": "abc123" + "rule_label": "xyz789" } ``` @@ -1642,9 +1725,9 @@ Describes a payment method that the shopper can use to pay for the order. ```json { "code": "abc123", - "is_deferred": false, + "is_deferred": true, "oope_payment_method_config": OopePaymentMethodConfig, - "title": "abc123" + "title": "xyz789" } ``` @@ -1675,12 +1758,12 @@ Contains details about the possible shipping methods and carriers. { "additional_data": [ShippingAdditionalData], "amount": Money, - "available": false, + "available": true, "carrier_code": "xyz789", "carrier_title": "abc123", - "error_message": "xyz789", + "error_message": "abc123", "method_code": "abc123", - "method_title": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1726,9 +1809,9 @@ Defines the billing address. ```json { "address": CartAddressInput, - "company_address_id": 4, - "customer_address_id": 987, - "customer_address_uid": 4, + "company_address_id": "4", + "customer_address_id": 123, + "customer_address_uid": "4", "same_as_shipping": true, "use_for_shipping": true } @@ -1758,9 +1841,9 @@ The billing address information "address_line_1": "abc123", "address_line_2": "xyz789", "city": "abc123", - "country_code": "abc123", + "country_code": "xyz789", "postal_code": "xyz789", - "region": "abc123" + "region": "xyz789" } ``` @@ -1798,16 +1881,16 @@ Contains details about the billing address. ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", - "company_address_id": "4", + "company_address_id": 4, "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, - "fax": "abc123", + "fax": "xyz789", "firstname": "abc123", - "id": 987, - "lastname": "xyz789", + "id": 123, + "lastname": "abc123", "middlename": "xyz789", "postcode": "abc123", "prefix": "abc123", @@ -1816,7 +1899,7 @@ Contains details about the billing address. "suffix": "xyz789", "telephone": "abc123", "uid": 4, - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -1826,12 +1909,6 @@ Contains details about the billing address. The `Boolean` scalar type represents `true` or `false`. -#### Example - -```json -true -``` - ### Breadcrumb @@ -1855,7 +1932,7 @@ Contains details about an individual category that comprises a breadcrumb. "category_level": 123, "category_name": "xyz789", "category_uid": "4", - "category_url_key": "abc123", + "category_url_key": "xyz789", "category_url_path": "abc123" } ``` @@ -1927,7 +2004,7 @@ An implementation for bundle product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "bundle_options": [SelectedBundleOption], "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], @@ -1935,14 +2012,14 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": true, + "is_available": false, "is_free_gift": true, - "is_salable": false, - "max_qty": 987.65, - "min_qty": 123.45, + "is_salable": true, + "max_qty": 123.45, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "xyz789", + "not_available_message": "abc123", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, @@ -1979,12 +2056,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_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 123.45 + "quantity_refunded": 987.65 } ``` @@ -2015,11 +2092,11 @@ Defines bundle product options for `InvoiceItemInterface`. "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": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 123.45 } ``` @@ -2048,9 +2125,9 @@ Defines an individual item within a bundle product. ```json { "options": [BundleItemOption], - "position": 987, + "position": 123, "price_range": PriceRange, - "required": true, + "required": false, "sku": "abc123", "title": "xyz789", "type": "xyz789", @@ -2082,14 +2159,14 @@ 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": "xyz789", + "label": "abc123", "position": 123, "price": 987.65, "price_type": "FIXED", "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -2143,22 +2220,22 @@ Defines bundle product options for `OrderItemInterface`. "free_gift_label": "xyz789", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, - "parent_sku": "abc123", + "id": "4", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 123.45, + "quantity_canceled": 987.65, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, + "quantity_return_requested": 987.65, "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -2232,32 +2309,32 @@ Defines basic features of a bundle product and contains multiple BundleItems. { "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_price": false, "dynamic_sku": true, "dynamic_weight": false, - "gift_message_available": true, - "gift_wrapping_available": false, + "gift_message_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "xyz789", + "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 123, - "max_sale_qty": 987.65, + "manufacturer": 987, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_description": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 123.45, "name": "xyz789", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "xyz789", - "only_x_left_in_stock": 123.45, + "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_details": PriceDetails, "price_range": PriceRange, "price_tiers": [TierPrice], @@ -2266,20 +2343,20 @@ Defines basic features of a bundle product and contains multiple BundleItems. "quantity": 987.65, "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "abc123", + "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "weight": 987.65 } ``` @@ -2308,7 +2385,7 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "sku": "abc123", "uid": 4 } @@ -2337,12 +2414,12 @@ Defines bundle product options for `ShipmentItemInterface`. ```json { "bundle_options": [ItemSelectedBundleOption], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -2368,13 +2445,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "added_at": "abc123", + "added_at": "xyz789", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -2398,13 +2475,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "abc123", - "height": 987, + "color": "xyz789", + "height": 123, "label": "xyz789", "layout": "xyz789", "shape": "abc123", "tagline": false, - "use_default_height": false + "use_default_height": true } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md index 040e4cf58..393cf7be9 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-c-e.md @@ -15,7 +15,7 @@ Specifies the quote template id of the quote template to cancel ```json { - "cancellation_comment": "xyz789", + "cancellation_comment": "abc123", "template_id": 4 } ``` @@ -36,7 +36,7 @@ Specifies the quote template id of the quote template to cancel ```json { "code": "ORDER_CANCELLATION_DISABLED", - "message": "abc123" + "message": "xyz789" } ``` @@ -77,7 +77,10 @@ Defines the order to cancel. #### Example ```json -{"order_id": 4, "reason": "abc123"} +{ + "order_id": "4", + "reason": "abc123" +} ``` @@ -98,7 +101,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "xyz789", + "error": "abc123", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -142,7 +145,7 @@ Contains the updated customer order and error message if any. "authentication_result": AuthenticationResult, "bin_details": CardBin, "card_expiry_month": "abc123", - "card_expiry_year": "abc123", + "card_expiry_year": "xyz789", "last_digits": "xyz789", "name": "abc123" } @@ -182,7 +185,7 @@ The card payment source information ```json { "billing_address": BillingAddressPaymentSourceInput, - "name": "xyz789" + "name": "abc123" } ``` @@ -204,8 +207,8 @@ The card payment source information ```json { - "brand": "xyz789", - "expiry": "abc123", + "brand": "abc123", + "expiry": "xyz789", "last_digits": "xyz789" } ``` @@ -257,20 +260,20 @@ 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": false, "gift_wrapping": GiftWrapping, "has_available_free_gifts": false, - "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 } ``` @@ -291,8 +294,8 @@ Contains details the country in a billing or shipping address. ```json { - "code": "abc123", - "label": "xyz789" + "code": "xyz789", + "label": "abc123" } ``` @@ -330,21 +333,21 @@ Defines the billing or shipping address to be applied to the cart. { "city": "xyz789", "company": "abc123", - "country_code": "abc123", + "country_code": "xyz789", "custom_attributes": [AttributeValueInput], - "fax": "abc123", - "firstname": "xyz789", + "fax": "xyz789", + "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", + "middlename": "abc123", + "postcode": "abc123", "prefix": "xyz789", "region": "xyz789", - "region_id": 987, + "region_id": 123, "save_in_address_book": true, "street": ["abc123"], "suffix": "xyz789", "telephone": "abc123", - "vat_id": "abc123" + "vat_id": "xyz789" } ``` @@ -387,7 +390,7 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "company_address_id": "4", "country": CartAddressCountry, @@ -396,16 +399,16 @@ Defines the billing or shipping address to be applied to the cart. "fax": "xyz789", "firstname": "abc123", "id": 987, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": CartAddressRegion, - "street": ["xyz789"], - "suffix": "abc123", + "street": ["abc123"], + "suffix": "xyz789", "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "uid": 4, + "vat_id": "xyz789" } ``` @@ -427,8 +430,8 @@ Contains details about the region in a billing or shipping address. ```json { - "code": "xyz789", - "label": "abc123", + "code": "abc123", + "label": "xyz789", "region_id": 987 } ``` @@ -450,7 +453,7 @@ Defines a cart custom attributes. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -491,7 +494,7 @@ Defines a cart item custom attributes. ```json { "cart_id": "abc123", - "cart_item_id": "abc123", + "cart_item_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -553,8 +556,8 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "abc123", - "quantity": 123.45, - "selected_options": [4], + "quantity": 987.65, + "selected_options": ["4"], "sku": "xyz789" } ``` @@ -608,8 +611,8 @@ An interface for products in a cart. "discount": [Discount], "errors": [CartItemError], "is_available": true, - "is_free_gift": true, - "is_salable": false, + "is_free_gift": false, + "is_salable": true, "max_qty": 987.65, "min_qty": 987.65, "nominated_source": SourceAvailability, @@ -620,7 +623,7 @@ An interface for products in a cart. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": "4" + "uid": 4 } ``` @@ -683,7 +686,7 @@ Contains details about the price of a selected customizable value. ```json { "type": "FIXED", - "units": "abc123", + "units": "xyz789", "value": 123.45 } ``` @@ -708,7 +711,7 @@ A single item to be updated. ```json { - "cart_item_uid": 4, + "cart_item_uid": "4", "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", @@ -734,7 +737,7 @@ A single item to be updated. { "items": [CartItemInterface], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -787,7 +790,7 @@ Contains details about the final price of items in the cart, including discount #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -808,7 +811,7 @@ Contains tax information about an item in the cart. ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -917,29 +920,29 @@ Swatch attribute metadata. ```json { "apply_to": ["SIMPLE"], - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "abc123", "frontend_input": "BOOLEAN", - "is_comparable": false, + "is_comparable": true, "is_filterable": true, "is_filterable_in_search": true, - "is_html_allowed_on_front": true, - "is_required": false, + "is_html_allowed_on_front": false, + "is_required": true, "is_searchable": false, "is_unique": false, "is_used_for_price_rules": false, - "is_used_for_promo_rules": false, + "is_used_for_promo_rules": true, "is_visible_in_advanced_search": true, "is_visible_on_front": false, - "is_wysiwyg_enabled": false, - "label": "xyz789", + "is_wysiwyg_enabled": true, + "label": "abc123", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", "update_product_preview_image": false, "use_product_image_for_swatch": false, - "used_in_product_listing": false + "used_in_product_listing": true } ``` @@ -963,8 +966,8 @@ New category bucket for federation ```json { "count": 123, - "id": "4", - "path": "abc123", + "id": 4, + "path": "xyz789", "title": "abc123" } ``` @@ -988,7 +991,7 @@ New category bucket for federation #### Example ```json -{"id": "4"} +{"id": 4} ``` @@ -1039,9 +1042,9 @@ Contains the full set of attributes that can be returned in a category search. { "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "abc123", - "children_count": "abc123", - "custom_layout_update_file": "abc123", + "canonical_url": "xyz789", + "children_count": "xyz789", + "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "abc123", "display_mode": "xyz789", @@ -1052,16 +1055,16 @@ Contains the full set of attributes that can be returned in a category search. "landing_page": 123, "level": 987, "meta_description": "xyz789", - "meta_keywords": "abc123", + "meta_keywords": "xyz789", "meta_title": "xyz789", "name": "abc123", "path": "xyz789", "path_in_store": "abc123", - "position": 123, + "position": 987, "product_count": 987, "uid": "4", - "url_key": "abc123", - "url_path": "abc123" + "url_key": "xyz789", + "url_path": "xyz789" } ``` @@ -1107,16 +1110,16 @@ Contains the hierarchy of categories. { "available_sort_by": ["xyz789"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "abc123", + "canonical_url": "abc123", + "children_count": "xyz789", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "xyz789", - "filter_price_range": 123.45, + "description": "xyz789", + "display_mode": "abc123", + "filter_price_range": 987.65, "image": "xyz789", "include_in_menu": 987, - "is_anchor": 123, + "is_anchor": 987, "landing_page": 987, "level": 123, "meta_description": "abc123", @@ -1126,10 +1129,10 @@ Contains the hierarchy of categories. "path": "xyz789", "path_in_store": "abc123", "position": 123, - "product_count": 987, + "product_count": 123, "uid": 4, "url_key": "abc123", - "url_path": "abc123" + "url_path": "xyz789" } ``` @@ -1163,16 +1166,16 @@ Represents a category. Contains information about a category, including the cate ```json { "availableSortBy": ["xyz789"], - "children": ["abc123"], + "children": ["xyz789"], "defaultSortBy": "abc123", - "id": 4, - "level": 987, + "id": "4", + "level": 123, "name": "xyz789", - "parentId": "xyz789", - "position": 123, + "parentId": "abc123", + "position": 987, "path": "xyz789", "roles": ["xyz789"], - "urlKey": "xyz789", + "urlKey": "abc123", "urlPath": "xyz789", "count": 987, "title": "abc123" @@ -1209,13 +1212,13 @@ Base interface defining essential category fields shared across all category vie ```json { - "availableSortBy": ["abc123"], - "defaultSortBy": "xyz789", + "availableSortBy": ["xyz789"], + "defaultSortBy": "abc123", "id": "4", "level": 987, "name": "xyz789", - "path": "xyz789", - "roles": ["abc123"], + "path": "abc123", + "roles": ["xyz789"], "urlKey": "abc123", "urlPath": "xyz789" } @@ -1243,13 +1246,13 @@ Defines details about an individual checkout agreement. ```json { - "agreement_id": 987, - "checkbox_text": "abc123", - "content": "xyz789", + "agreement_id": 123, + "checkbox_text": "xyz789", + "content": "abc123", "content_height": "xyz789", - "is_html": false, + "is_html": true, "mode": "AUTO", - "name": "xyz789" + "name": "abc123" } ``` @@ -1332,7 +1335,7 @@ Contains details about errors encountered when a customer clear cart. #### Example ```json -{"message": "xyz789", "type": "NOT_FOUND"} +{"message": "abc123", "type": "NOT_FOUND"} ``` @@ -1369,7 +1372,7 @@ Assigns a specific `cart_id` to the empty cart. #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -1485,7 +1488,7 @@ Defines the negotiable quotes to mark as closed. #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -1527,7 +1530,7 @@ Contains the closed negotiable quotes and other negotiable quotes the company us #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -1641,12 +1644,12 @@ Contains the output schema for a company. "default_billing_address": CompanyAddress, "default_shipping_address": CompanyAddress, "email": "xyz789", - "id": "4", + "id": 4, "legal_address": CompanyLegalAddress, "legal_name": "xyz789", "name": "xyz789", "payment_methods": ["xyz789"], - "reseller_id": "xyz789", + "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1655,7 +1658,7 @@ Contains the output schema for a company. "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "abc123" + "vat_tax_id": "xyz789" } ``` @@ -1681,7 +1684,7 @@ Contains details about the access control list settings of a resource. "children": [CompanyAclResource], "id": "4", "sort_order": 123, - "text": "abc123" + "text": "xyz789" } ``` @@ -1721,18 +1724,18 @@ Contains details about the access control list settings of a resource. ```json { "address_type": "BILLING", - "city": "xyz789", - "company": "abc123", - "company_id": "4", + "city": "abc123", + "company": "xyz789", + "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", "id": "4", "is_default": false, - "lastname": "abc123", - "middlename": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "nickname": "xyz789", "postcode": "abc123", "prefix": "abc123", @@ -1740,7 +1743,7 @@ Contains details about the access control list settings of a resource. "region_id": 123, "street": ["abc123"], "suffix": "abc123", - "telephone": "abc123", + "telephone": "xyz789", "vat_id": "xyz789" } ``` @@ -1786,16 +1789,16 @@ Defines the input schema for creating a company address. "fax": "xyz789", "firstname": "xyz789", "is_default": true, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", - "nickname": "xyz789", + "nickname": "abc123", "postcode": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "abc123" + "telephone": "abc123", + "vat_id": "xyz789" } ``` @@ -1853,12 +1856,12 @@ Defines the input schema for updating a company address. The address type cannot "country_code": "AF", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "is_default": true, - "lastname": "abc123", - "middlename": "abc123", + "lastname": "xyz789", + "middlename": "xyz789", "nickname": "xyz789", - "postcode": "abc123", + "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["xyz789"], @@ -1888,7 +1891,7 @@ Contains a paginated list of company addresses. { "items": [CompanyAddress], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1917,9 +1920,9 @@ Defines the input schema for creating a company administrator. "custom_attributes": [AttributeValueInput], "email": "abc123", "firstname": "abc123", - "gender": 987, - "job_title": "abc123", - "lastname": "xyz789", + "gender": 123, + "job_title": "xyz789", + "lastname": "abc123", "telephone": "xyz789" } ``` @@ -1942,7 +1945,7 @@ Describes a carrier-level shipping option available to the company. ```json { "code": "xyz789", - "title": "xyz789" + "title": "abc123" } ``` @@ -1969,7 +1972,7 @@ The minimal required information to identify and display the company. "id": 4, "is_admin": true, "legal_name": "abc123", - "name": "abc123", + "name": "xyz789", "status": "PENDING" } ``` @@ -2023,7 +2026,7 @@ Defines the input schema for creating a new company. "company_name": "abc123", "legal_address": CompanyLegalAddressCreateInput, "legal_name": "abc123", - "reseller_id": "xyz789", + "reseller_id": "abc123", "vat_tax_id": "abc123" } ``` @@ -2098,7 +2101,7 @@ Defines a filter for narrowing the results of a credit history search. { "custom_reference_number": "abc123", "operation_type": "ALLOCATION", - "updated_by": "abc123" + "updated_by": "xyz789" } ``` @@ -2169,7 +2172,7 @@ Defines the administrator or company user that submitted a company credit operat #### Example ```json -{"name": "abc123", "type": "CUSTOMER"} +{"name": "xyz789", "type": "CUSTOMER"} ``` @@ -2230,7 +2233,7 @@ Defines the input schema for accepting the company invitation. ```json { "code": "abc123", - "role_id": "4", + "role_id": 4, "user": CompanyInvitationUserInput } ``` @@ -2250,7 +2253,7 @@ The result of accepting the company invitation. #### Example ```json -{"success": true} +{"success": false} ``` @@ -2274,7 +2277,7 @@ Company user attributes in the invitation. ```json { "company_id": 4, - "customer_id": "4", + "customer_id": 4, "job_title": "xyz789", "status": "ACTIVE", "telephone": "xyz789" @@ -2302,12 +2305,12 @@ Contains details about the address where the company is registered to conduct bu ```json { - "city": "abc123", + "city": "xyz789", "country_code": "AF", "postcode": "abc123", "region": CustomerAddressRegion, "street": ["abc123"], - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2332,7 +2335,7 @@ Defines the input schema for defining a company's legal address. ```json { - "city": "abc123", + "city": "xyz789", "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, @@ -2364,10 +2367,10 @@ Defines the input schema for updating a company's legal address. { "city": "xyz789", "country_id": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "telephone": "xyz789" + "street": ["xyz789"], + "telephone": "abc123" } ``` @@ -2390,8 +2393,8 @@ Contails details about a single role. ```json { - "id": 4, - "name": "xyz789", + "id": "4", + "name": "abc123", "permissions": [CompanyAclResource], "users_count": 123 } @@ -2439,7 +2442,7 @@ Defines the input schema for updating a company role. { "id": "4", "name": "abc123", - "permissions": ["xyz789"] + "permissions": ["abc123"] } ``` @@ -2487,7 +2490,7 @@ Contains details about a company sales representative. { "email": "abc123", "firstname": "xyz789", - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -2564,11 +2567,7 @@ Defines an individual node in the company structure. #### Example ```json -{ - "entity": CompanyTeam, - "id": "4", - "parent_id": "4" -} +{"entity": CompanyTeam, "id": 4, "parent_id": 4} ``` @@ -2587,7 +2586,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"} ``` @@ -2611,8 +2610,8 @@ Describes a company team. { "description": "abc123", "id": 4, - "name": "abc123", - "structure_id": "4" + "name": "xyz789", + "structure_id": 4 } ``` @@ -2635,7 +2634,7 @@ Defines the input schema for creating a company team. ```json { "description": "xyz789", - "name": "xyz789", + "name": "abc123", "target_id": 4 } ``` @@ -2658,9 +2657,9 @@ Defines the input schema for updating a company team. ```json { - "description": "xyz789", + "description": "abc123", "id": "4", - "name": "abc123" + "name": "xyz789" } ``` @@ -2685,8 +2684,8 @@ Defines the input schema for updating a company. ```json { - "company_email": "abc123", - "company_name": "xyz789", + "company_email": "xyz789", + "company_name": "abc123", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "abc123", "reseller_id": "abc123", @@ -2718,13 +2717,13 @@ Defines the input schema for creating a company user. ```json { "email": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "job_title": "xyz789", - "lastname": "abc123", - "role_id": 4, + "lastname": "xyz789", + "role_id": "4", "status": "ACTIVE", "target_id": 4, - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -2770,12 +2769,12 @@ Defines the input schema for updating a company user. ```json { - "email": "abc123", + "email": "xyz789", "firstname": "abc123", "id": 4, - "job_title": "abc123", + "job_title": "xyz789", "lastname": "xyz789", - "role_id": 4, + "role_id": "4", "status": "ACTIVE", "telephone": "xyz789" } @@ -2801,7 +2800,7 @@ Contains details about company users. { "items": [Customer], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2840,7 +2839,7 @@ Contains an attribute code that is used for product comparisons. ```json { - "code": "xyz789", + "code": "abc123", "label": "xyz789" } ``` @@ -2865,7 +2864,7 @@ Defines an object used to iterate through items for product comparisons. { "attributes": [ProductAttribute], "product": ProductInterface, - "uid": 4 + "uid": "4" } ``` @@ -2912,8 +2911,8 @@ Update the quote and complete the order ```json { - "cartId": "abc123", - "id": "xyz789" + "cartId": "xyz789", + "id": "abc123" } ``` @@ -2957,31 +2956,31 @@ Represents all product types, except simple products. Complex product prices are ```json { - "addToCartAllowed": true, + "addToCartAllowed": false, "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": "xyz789", - "metaTitle": "xyz789", + "metaTitle": "abc123", "name": "abc123", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, - "shortDescription": "xyz789", - "sku": "abc123", + "shortDescription": "abc123", + "sku": "xyz789", "externalId": "abc123", "externalIds": [ExternalId], - "url": "abc123", - "urlKey": "abc123", + "url": "xyz789", + "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "xyz789" + "queryType": "abc123", + "visibility": "abc123" } ``` @@ -2998,7 +2997,7 @@ Represents all product types, except simple products. Complex product prices are #### Example ```json -{"html": "xyz789"} +{"html": "abc123"} ``` @@ -3043,7 +3042,7 @@ Contains details about a configurable product attribute option. ```json { "code": "abc123", - "label": "xyz789", + "label": "abc123", "uid": 4, "value_index": 987 } @@ -3089,7 +3088,7 @@ An implementation for configurable product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -3099,10 +3098,10 @@ An implementation for configurable product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "is_free_gift": true, + "is_free_gift": false, "is_salable": true, - "max_qty": 987.65, - "min_qty": 987.65, + "max_qty": 123.45, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "xyz789", @@ -3111,7 +3110,7 @@ An implementation for configurable product cart items. "prices": CartItemPrices, "product": ProductInterface, "quantity": 123.45, - "uid": 4 + "uid": "4" } ``` @@ -3183,21 +3182,21 @@ Describes configurable options that have been selected and can be selected as a "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "abc123", + "parent_sku": "xyz789", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "xyz789", + "product_url_key": "abc123", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, + "quantity_refunded": 987.65, + "quantity_return_requested": 987.65, "quantity_returned": 987.65, - "quantity_shipped": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], "status": "abc123" } @@ -3277,39 +3276,39 @@ Defines basic features of a configurable product and its simple product variants "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 987.65, + "is_returnable": "xyz789", + "manufacturer": 123, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "xyz789", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "abc123", "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "variants": [ConfigurableVariant], "weight": 987.65 } @@ -3336,7 +3335,7 @@ Contains details about configurable product options. { "attribute_code": "abc123", "label": "xyz789", - "uid": "4", + "uid": 4, "values": [ConfigurableProductOptionValue] } ``` @@ -3361,8 +3360,8 @@ Defines a value for a configurable product option. ```json { - "is_available": true, - "is_use_default": false, + "is_available": false, + "is_use_default": true, "label": "xyz789", "swatch": SwatchDataInterface, "uid": 4 @@ -3391,11 +3390,11 @@ Defines configurable attributes for the specified product. ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "attribute_uid": 4, - "label": "abc123", - "position": 123, - "uid": "4", + "label": "xyz789", + "position": 987, + "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] } @@ -3452,9 +3451,9 @@ Contains the index number assigned to a configurable product option. { "default_label": "abc123", "label": "abc123", - "store_label": "xyz789", + "store_label": "abc123", "swatch_data": SwatchDataInterface, - "uid": "4", + "uid": 4, "use_default_value": false } ``` @@ -3483,7 +3482,7 @@ Contains details about configurable products added to a requisition list. "configurable_options": [SelectedConfigurableOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "sku": "xyz789", "uid": 4 } @@ -3534,14 +3533,14 @@ A configurable product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "abc123", - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -3582,8 +3581,8 @@ Contains details about a customer email address to confirm. ```json { - "confirmation_key": "xyz789", - "email": "abc123" + "confirmation_key": "abc123", + "email": "xyz789" } ``` @@ -3602,7 +3601,7 @@ Contains details about a customer email address to confirm. ```json { - "confirmation_key": "abc123", + "confirmation_key": "xyz789", "order_id": "4" } ``` @@ -3643,10 +3642,10 @@ List of account confirmation statuses. ```json { - "comment": "abc123", + "comment": "xyz789", "email": "abc123", "name": "xyz789", - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -3748,11 +3747,11 @@ Contains the source and target wish lists after copying products. ```json { "available_regions": [Region], - "full_name_english": "abc123", - "full_name_locale": "abc123", + "full_name_english": "xyz789", + "full_name_locale": "xyz789", "id": "abc123", - "three_letter_abbreviation": "xyz789", - "two_letter_abbreviation": "abc123" + "three_letter_abbreviation": "abc123", + "two_letter_abbreviation": "xyz789" } ``` @@ -4105,7 +4104,7 @@ Contains an array of product IDs to use for creating a compare list. #### Example ```json -{"products": ["4"]} +{"products": [4]} ``` @@ -4135,7 +4134,7 @@ Defines a new gift registry. GiftRegistryDynamicAttributeInput ], "event_name": "abc123", - "gift_registry_type_uid": 4, + "gift_registry_type_uid": "4", "message": "xyz789", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], @@ -4241,8 +4240,8 @@ Contains payment order details that are used while processing the payment order "cartId": "xyz789", "location": "PRODUCT_DETAIL", "methodCode": "abc123", - "paymentSource": "abc123", - "vaultIntent": true + "paymentSource": "xyz789", + "vaultIntent": false } ``` @@ -4266,11 +4265,11 @@ Contains payment order details that are used while processing the payment order ```json { - "amount": 987.65, + "amount": 123.45, "currency_code": "xyz789", "id": "xyz789", - "mp_order_id": "abc123", - "status": "xyz789" + "mp_order_id": "xyz789", + "status": "abc123" } ``` @@ -4298,7 +4297,7 @@ Defines a new product review. "ratings": [ProductReviewRatingInput], "sku": "abc123", "summary": "abc123", - "text": "xyz789" + "text": "abc123" } ``` @@ -4361,7 +4360,7 @@ Defines a set of conditions that apply to a rule. "amount": CreatePurchaseOrderApprovalRuleConditionAmountInput, "attribute": "GRAND_TOTAL", "operator": "MORE_THAN", - "quantity": 123 + "quantity": 987 } ``` @@ -4376,6 +4375,7 @@ An input object that identifies and describes a new requisition list. | Input Field | Description | |-------------|-------------| | `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | An optional description of the requisition list. | +| `is_public` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the requisition list is publicly shareable. Optional; defaults to false (private) when omitted. | | `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name assigned to the requisition list. | #### Example @@ -4383,7 +4383,8 @@ An input object that identifies and describes a new requisition list. ```json { "description": "abc123", - "name": "abc123" + "is_public": false, + "name": "xyz789" } ``` @@ -4422,8 +4423,8 @@ Describe the variables needed to create a vault payment token ```json { - "card_description": "xyz789", - "setup_token_id": "xyz789" + "card_description": "abc123", + "setup_token_id": "abc123" } ``` @@ -4445,7 +4446,7 @@ The vault token id and information about the payment source ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "xyz789" + "vault_token_id": "abc123" } ``` @@ -4486,7 +4487,7 @@ The setup token id information #### Example ```json -{"setup_token": "abc123"} +{"setup_token": "xyz789"} ``` @@ -4505,7 +4506,7 @@ Defines the name and visibility of a new wish list. #### Example ```json -{"name": "xyz789", "visibility": "PUBLIC"} +{"name": "abc123", "visibility": "PUBLIC"} ``` @@ -4601,7 +4602,7 @@ Defines a credit memo item's custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, @@ -4628,8 +4629,8 @@ Defines a credit memo's custom attributes. ```json { - "credit_memo_id": "xyz789", - "credit_memo_item_id": "abc123", + "credit_memo_id": "abc123", + "credit_memo_item_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -4668,12 +4669,12 @@ Credit memo item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -4750,8 +4751,8 @@ Contains credit memo price details. ```json { - "available_currency_codes": ["abc123"], - "base_currency_code": "xyz789", + "available_currency_codes": ["xyz789"], + "base_currency_code": "abc123", "base_currency_symbol": "xyz789", "default_display_currency_code": "abc123", "default_display_currency_symbol": "abc123", @@ -4961,7 +4962,7 @@ Attributes of the product currently being viewed on PDP #### Example ```json -{"sku": "abc123", "price": 123.45} +{"sku": "xyz789", "price": 123.45} ``` @@ -4981,8 +4982,8 @@ Specifies the custom attribute code and value. ```json { - "attribute_code": "xyz789", - "value": "xyz789" + "attribute_code": "abc123", + "value": "abc123" } ``` @@ -5003,8 +5004,8 @@ Defines a custom attribute. ```json { - "attribute_code": "xyz789", - "value": "xyz789" + "attribute_code": "abc123", + "value": "abc123" } ``` @@ -5041,14 +5042,14 @@ 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": "abc123", "frontend_input": "BOOLEAN", - "is_required": false, + "is_required": true, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -5077,7 +5078,7 @@ An interface containing fields that define the EAV attribute. { "is_default": false, "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -5119,7 +5120,7 @@ A simple key value object. ```json { "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", - "value": ["xyz789"] + "value": ["abc123"] } ``` @@ -5207,7 +5208,7 @@ Defines the customer name, addresses, and other details. "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, @@ -5216,20 +5217,20 @@ Defines the customer name, addresses, and other details. "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", "default_billing": "xyz789", - "default_shipping": "abc123", - "email": "xyz789", - "firstname": "abc123", + "default_shipping": "xyz789", + "email": "abc123", + "firstname": "xyz789", "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, - "is_subscribed": false, + "id": "4", + "is_subscribed": true, "job_title": "abc123", "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, @@ -5246,7 +5247,7 @@ Defines the customer name, addresses, and other details. "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "abc123", "taxvat": "abc123", "team": CompanyTeam, @@ -5292,25 +5293,25 @@ Contains detailed information about a customer's billing or shipping address. ```json { - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, - "default_shipping": true, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", - "firstname": "abc123", + "fax": "abc123", + "firstname": "xyz789", "id": 123, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "abc123", "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", + "suffix": "xyz789", + "telephone": "abc123", "uid": 4, "vat_id": "abc123" } @@ -5377,14 +5378,14 @@ Contains details about a billing or shipping address. "default_billing": true, "default_shipping": true, "fax": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegionInput, "street": ["abc123"], - "suffix": "abc123", + "suffix": "xyz789", "telephone": "xyz789", "vat_id": "xyz789" } @@ -5408,9 +5409,9 @@ Defines the customer's state or province. ```json { - "region": "abc123", + "region": "xyz789", "region_code": "abc123", - "region_id": 987 + "region_id": 123 } ``` @@ -5432,7 +5433,7 @@ Defines the customer's state or province. ```json { - "region": "xyz789", + "region": "abc123", "region_code": "xyz789", "region_id": 987 } @@ -5488,16 +5489,16 @@ Customer attribute metadata. ```json { - "code": 4, + "code": "4", "default_value": "abc123", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, - "is_unique": false, - "label": "abc123", - "multiline_count": 987, + "is_required": false, + "is_unique": true, + "label": "xyz789", + "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -5535,16 +5536,16 @@ An input object for creating a customer. "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], "date_of_birth": "abc123", - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "is_subscribed": true, - "lastname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "password": "abc123", - "prefix": "abc123", - "suffix": "xyz789", - "taxvat": "xyz789" + "password": "xyz789", + "prefix": "xyz789", + "suffix": "abc123", + "taxvat": "abc123" } ``` @@ -5569,10 +5570,10 @@ Contains details about a single downloadable product. ```json { "date": "abc123", - "download_url": "abc123", + "download_url": "xyz789", "order_increment_id": "abc123", "remaining_downloads": "abc123", - "status": "xyz789" + "status": "abc123" } ``` @@ -5609,7 +5610,7 @@ Data of customer group. #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -5659,7 +5660,7 @@ Contains details about each of the customer's orders. ```json { - "admin_assisted_order": 987, + "admin_assisted_order": 123, "applied_coupons": [AppliedCoupon], "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], @@ -5671,9 +5672,9 @@ Contains details about each of the customer's orders. "customer_info": OrderCustomerInfo, "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": false, + "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], "is_virtual": true, "items": [OrderItemInterface], @@ -5681,15 +5682,15 @@ Contains details about each of the customer's orders. "negotiable_quote": NegotiableQuote, "number": "xyz789", "order_date": "xyz789", - "order_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "abc123", - "status": "xyz789", - "token": "abc123", + "shipping_method": "xyz789", + "status": "abc123", + "token": "xyz789", "total": OrderTotal } ``` @@ -5754,7 +5755,7 @@ The collection of orders that match the conditions defined in the filter. "date_of_first_order": "abc123", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5781,7 +5782,7 @@ Identifies the filter to use for filtering orders. "grand_total": FilterRangeTypeInput, "number": FilterStringTypeInput, "order_date": FilterRangeTypeInput, - "search": "abc123", + "search": "xyz789", "status": FilterEqualTypeInput } ``` @@ -5837,7 +5838,7 @@ Customer segment details #### Example ```json -{"uid": 4} +{"uid": "4"} ``` @@ -5860,7 +5861,7 @@ Contains store credit information with balance and history. { "balance_history": CustomerStoreCreditHistory, "current_balance": Money, - "enabled": false + "enabled": true } ``` @@ -5884,7 +5885,7 @@ Lists changes to the amount of store credit available to the customer. { "items": [CustomerStoreCreditHistoryItem], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5910,7 +5911,7 @@ Contains store credit history information. "action": "abc123", "actual_balance": Money, "balance_change": Money, - "date_time_changed": "abc123" + "date_time_changed": "xyz789" } ``` @@ -5958,17 +5959,17 @@ An input object for updating a customer. ```json { - "allow_remote_shopping_assistance": false, + "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "gender": 987, "is_subscribed": true, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "prefix": "abc123", + "prefix": "xyz789", "suffix": "abc123", - "taxvat": "abc123" + "taxvat": "xyz789" } ``` @@ -5997,7 +5998,7 @@ Contains information about a text area that is defined as part of a customizable "required": false, "sort_order": 123, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableAreaValue } ``` @@ -6025,7 +6026,7 @@ Defines the price and sku of a product whose page contains a customized text are "max_characters": 123, "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "uid": "4" } ``` @@ -6050,10 +6051,10 @@ Contains information about a set of checkbox values that are defined as part of ```json { - "required": true, - "sort_order": 987, + "required": false, + "sort_order": 123, "title": "abc123", - "uid": 4, + "uid": "4", "value": [CustomizableCheckboxValue] } ``` @@ -6081,11 +6082,11 @@ Defines the price and sku of a product whose page contains a customized set of c ```json { "option_type_id": 987, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": 4 } ``` @@ -6112,9 +6113,9 @@ Contains information about a date picker that is defined as part of a customizab ```json { "product_sku": "abc123", - "required": false, + "required": true, "sort_order": 987, - "title": "abc123", + "title": "xyz789", "uid": 4, "value": CustomizableDateValue } @@ -6162,7 +6163,7 @@ Defines the price and sku of a product whose page contains a customized date pic { "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "type": "DATE", "uid": 4 } @@ -6190,8 +6191,8 @@ Contains information about a drop down menu that is defined as part of a customi { "required": true, "sort_order": 123, - "title": "abc123", - "uid": "4", + "title": "xyz789", + "uid": 4, "value": [CustomizableDropDownValue] } ``` @@ -6218,10 +6219,10 @@ Defines the price and sku of a product whose page contains a customized drop dow ```json { - "option_type_id": 987, - "price": 987.65, + "option_type_id": 123, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, "title": "xyz789", "uid": "4" @@ -6251,9 +6252,9 @@ Contains information about a text field that is defined as part of a customizabl { "product_sku": "xyz789", "required": true, - "sort_order": 123, + "sort_order": 987, "title": "xyz789", - "uid": "4", + "uid": 4, "value": CustomizableFieldValue } ``` @@ -6282,7 +6283,7 @@ Defines the price and sku of a product whose page contains a customized text fie "price": 123.45, "price_type": "FIXED", "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6308,10 +6309,10 @@ Contains information about a file picker that is defined as part of a customizab ```json { "product_sku": "xyz789", - "required": true, + "required": false, "sort_order": 123, - "title": "abc123", - "uid": "4", + "title": "xyz789", + "uid": 4, "value": CustomizableFileValue } ``` @@ -6338,9 +6339,9 @@ Defines the price and sku of a product whose page contains a customized file pic ```json { - "file_extension": "abc123", + "file_extension": "xyz789", "image_size_x": 123, - "image_size_y": 987, + "image_size_y": 123, "price": 123.45, "price_type": "FIXED", "sku": "abc123", @@ -6370,7 +6371,7 @@ Contains information about a multiselect that is defined as part of a customizab { "required": false, "sort_order": 123, - "title": "abc123", + "title": "xyz789", "uid": "4", "value": [CustomizableMultipleValue] } @@ -6424,10 +6425,7 @@ Defines a customizable option. #### Example ```json -{ - "uid": "4", - "value_string": "abc123" -} +{"uid": 4, "value_string": "xyz789"} ``` @@ -6462,10 +6460,10 @@ Contains basic information about a customizable option. It can be implemented by ```json { - "required": true, - "sort_order": 987, - "title": "abc123", - "uid": 4 + "required": false, + "sort_order": 123, + "title": "xyz789", + "uid": "4" } ``` @@ -6518,9 +6516,9 @@ Contains information about a set of radio buttons that are defined as part of a ```json { - "required": false, - "sort_order": 123, - "title": "xyz789", + "required": true, + "sort_order": 987, + "title": "abc123", "uid": "4", "value": [CustomizableRadioValue] } @@ -6548,8 +6546,8 @@ Defines the price and sku of a product whose page contains a customized set of r ```json { - "option_type_id": 987, - "price": 123.45, + "option_type_id": 123, + "price": 987.65, "price_type": "FIXED", "sku": "abc123", "sort_order": 123, @@ -6585,7 +6583,7 @@ Contains the response to the request to delete the company role. #### Example ```json -{"success": false} +{"success": true} ``` @@ -6639,7 +6637,7 @@ Contains the results of the request to delete a compare list. #### Example ```json -{"result": true} +{"result": false} ``` @@ -6678,7 +6676,7 @@ Contains details about a failed delete operation on a negotiable quote. ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -6714,7 +6712,7 @@ Specifies the quote template id of the quote template to delete #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -6777,7 +6775,7 @@ Indicates whether the request succeeded and returns the remaining customer payme ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": false + "result": true } ``` @@ -6797,7 +6795,7 @@ Contains details about an error that occurred when deleting an approval rule . #### Example ```json -{"message": "xyz789", "type": "UNDEFINED"} +{"message": "abc123", "type": "UNDEFINED"} ``` @@ -6906,7 +6904,7 @@ Contains the status of the request to delete a wish list and an array of the cus #### Example ```json -{"status": true, "wishlists": [Wishlist]} +{"status": false, "wishlists": [Wishlist]} ``` @@ -6934,10 +6932,10 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": true, - "label": "abc123", - "type": "abc123", - "value": 987.65 + "is_discounting_locked": false, + "label": "xyz789", + "type": "xyz789", + "value": 123.45 } ``` @@ -6977,13 +6975,13 @@ An implementation for downloadable product cart items. ```json { - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "is_available": true, - "is_free_gift": false, + "is_free_gift": true, "is_salable": false, "links": [DownloadableProductLinks], "max_qty": 123.45, @@ -6997,7 +6995,7 @@ An implementation for downloadable product cart items. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": "4" + "uid": 4 } ``` @@ -7028,7 +7026,7 @@ Defines downloadable product options for `CreditMemoItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, @@ -7064,9 +7062,9 @@ Defines downloadable product options for `InvoiceItemInterface`. "custom_attributes": [CustomAttribute], "discounts": [Discount], "downloadable_links": [DownloadableItemsLinks], - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "quantity_invoiced": 123.45 @@ -7091,9 +7089,9 @@ Defines characteristics of the links for downloadable product. ```json { - "sort_order": 987, + "sort_order": 123, "title": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -7140,7 +7138,7 @@ 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], "free_gift_label": "abc123", "gift_message": GiftMessage, @@ -7148,18 +7146,18 @@ Defines downloadable product options for `OrderItemInterface`. "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", "product_url_key": "abc123", - "quantity_canceled": 123.45, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, + "quantity_canceled": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 123.45, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "abc123" } @@ -7229,7 +7227,7 @@ Defines a product that the shopper downloads. { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -7239,13 +7237,13 @@ Defines a product that the shopper downloads. "downloadable_product_samples": [ DownloadableProductSamples ], - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "links_purchased_separately": 123, - "links_title": "xyz789", + "links_title": "abc123", "manufacturer": 987, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], @@ -7254,18 +7252,18 @@ Defines a product that the shopper downloads. "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "abc123", - "new_from_date": "xyz789", - "new_to_date": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, - "rating_summary": 987.65, + "quantity": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", @@ -7277,7 +7275,7 @@ Defines a product that the shopper downloads. "thumbnail": ProductImage, "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123" + "url_key": "xyz789" } ``` @@ -7327,11 +7325,11 @@ Defines characteristics of a downloadable product. ```json { - "price": 123.45, - "sample_url": "xyz789", + "price": 987.65, + "sample_url": "abc123", "sort_order": 987, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -7350,7 +7348,7 @@ Contains the link ID for the downloadable product. #### Example ```json -{"link_id": 123} +{"link_id": 987} ``` @@ -7371,7 +7369,7 @@ Defines characteristics of a downloadable product. ```json { - "sample_url": "xyz789", + "sample_url": "abc123", "sort_order": 987, "title": "xyz789" } @@ -7402,7 +7400,7 @@ Contains details about downloadable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "links": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples], "sku": "xyz789", "uid": 4 @@ -7432,13 +7430,13 @@ A downloadable product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "samples": [DownloadableProductSamples] } ``` @@ -7520,7 +7518,7 @@ Defines a customer-entered option. ```json { "uid": "4", - "value": "abc123" + "value": "xyz789" } ``` @@ -7549,7 +7547,7 @@ An error encountered while adding an item to the the cart. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -7618,7 +7616,7 @@ Contains details about an address. ```json { "address": EstimateAddressInput, - "cart_id": "xyz789", + "cart_id": "abc123", "shipping_method": ShippingMethodInput } ``` @@ -7677,7 +7675,7 @@ Contains customer token for external customer. ```json { "customer": Customer, - "token": "xyz789" + "token": "abc123" } ``` @@ -7697,7 +7695,7 @@ Lists the exchange rate. #### Example ```json -{"currency_to": "xyz789", "rate": 123.45} +{"currency_to": "xyz789", "rate": 987.65} ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md index f55dd0288..4ba63ce0e 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-f-i.md @@ -21,10 +21,10 @@ { "code": "xyz789", "is_visible": true, - "payment_intent": "xyz789", + "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "three_ds_mode": "OFF", "title": "abc123" } @@ -47,8 +47,8 @@ Fastlane Payment inputs ```json { - "payment_source": "xyz789", - "paypal_fastlane_token": "abc123" + "payment_source": "abc123", + "paypal_fastlane_token": "xyz789" } ``` @@ -68,6 +68,7 @@ Fastlane Payment inputs | `LOW_STOCK` | | | `TYPE` | | | `VISIBILITY` | | +| `ATTRIBUTE` | | #### Example @@ -130,7 +131,7 @@ Defines a filter that performs a fuzzy search. #### Example ```json -{"match": "abc123", "match_type": "FULL"} +{"match": "xyz789", "match_type": "FULL"} ``` @@ -150,7 +151,7 @@ Defines a filter that matches a range of values, such as prices or dates. ```json { - "from": "xyz789", + "from": "abc123", "to": "xyz789" } ``` @@ -213,8 +214,8 @@ Defines a filter for an input string. ```json { - "eq": "abc123", - "in": ["xyz789"], + "eq": "xyz789", + "in": ["abc123"], "match": "abc123" } ``` @@ -248,20 +249,20 @@ Defines the comparison operators that can be used in a filter. ```json { - "eq": "xyz789", - "from": "abc123", + "eq": "abc123", + "from": "xyz789", "gt": "xyz789", - "gteq": "xyz789", + "gteq": "abc123", "in": ["xyz789"], - "like": "xyz789", + "like": "abc123", "lt": "abc123", - "lteq": "abc123", + "lteq": "xyz789", "moreq": "abc123", "neq": "xyz789", "nin": ["xyz789"], - "notnull": "xyz789", - "null": "abc123", - "to": "xyz789" + "notnull": "abc123", + "null": "xyz789", + "to": "abc123" } ``` @@ -284,9 +285,9 @@ Contains product attributes that can be used for filtering in a `productSearch` ```json { - "attribute": "abc123", + "attribute": "xyz789", "frontendInput": "abc123", - "label": "abc123", + "label": "xyz789", "numeric": false } ``` @@ -309,7 +310,7 @@ A single FPT that can be applied to a product price. ```json { "amount": Money, - "label": "abc123" + "label": "xyz789" } ``` @@ -362,7 +363,7 @@ Identifies which customer requires remote shopping assistance. #### Example ```json -{"customer_email": "abc123"} +{"customer_email": "xyz789"} ``` @@ -398,7 +399,7 @@ Specifies the template id, from which to generate quote from. #### Example ```json -{"template_id": 4} +{"template_id": "4"} ``` @@ -457,7 +458,7 @@ Contains details about the gift card account. { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } ``` @@ -503,7 +504,7 @@ Contains the value of a gift card, the website that generated the card, and rela "uid": 4, "value": 123.45, "website_id": 987, - "website_value": 987.65 + "website_value": 123.45 } ``` @@ -552,7 +553,7 @@ Contains details about a gift card that has been added to a cart. { "amount": Money, "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -560,9 +561,9 @@ Contains details about a gift card that has been added to a cart. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "is_free_gift": false, - "is_salable": false, - "max_qty": 123.45, + "is_free_gift": true, + "is_salable": true, + "max_qty": 987.65, "message": "xyz789", "min_qty": 987.65, "nominated_source": SourceAvailability, @@ -572,10 +573,10 @@ Contains details about a gift card that has been added to a cart. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "recipient_email": "xyz789", + "quantity": 987.65, + "recipient_email": "abc123", "recipient_name": "abc123", - "sender_email": "abc123", + "sender_email": "xyz789", "sender_name": "xyz789", "uid": 4 } @@ -606,12 +607,12 @@ 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": "xyz789", - "quantity_refunded": 987.65 + "product_sku": "abc123", + "quantity_refunded": 123.45 } ``` @@ -640,11 +641,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": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_invoiced": 987.65 } ``` @@ -671,9 +672,9 @@ Contains details about a gift card. { "message": "abc123", "recipient_email": "abc123", - "recipient_name": "xyz789", - "sender_email": "abc123", - "sender_name": "xyz789" + "recipient_name": "abc123", + "sender_email": "xyz789", + "sender_name": "abc123" } ``` @@ -701,9 +702,9 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "abc123", - "recipient_email": "abc123", - "recipient_name": "xyz789", + "message": "xyz789", + "recipient_email": "xyz789", + "recipient_name": "abc123", "sender_email": "abc123", "sender_name": "abc123" } @@ -749,7 +750,7 @@ Contains details about the sender, recipient, and amount of a gift card. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": true, + "eligible_for_return": false, "entered_options": [OrderItemOption], "free_gift_label": "abc123", "gift_card": GiftCardItem, @@ -758,17 +759,17 @@ Contains details about the sender, recipient, and amount of a gift card. "id": 4, "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "abc123", "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, + "quantity_invoiced": 987.65, "quantity_ordered": 123.45, "quantity_refunded": 987.65, "quantity_return_requested": 123.45, - "quantity_returned": 123.45, + "quantity_returned": 987.65, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" @@ -846,55 +847,55 @@ Defines properties of a gift card. { "allow_message": true, "allow_open_amount": true, - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": false, + "gift_message_available": true, "gift_wrapping_available": false, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], "giftcard_type": "VIRTUAL", "image": ProductImage, "is_redeemable": false, - "is_returnable": "xyz789", + "is_returnable": "abc123", "lifetime": 123, - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "message_max_length": 123, "meta_description": "xyz789", - "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", + "name": "abc123", "new_from_date": "abc123", - "new_to_date": "xyz789", + "new_to_date": "abc123", "only_x_left_in_stock": 987.65, "open_amount_max": 987.65, "open_amount_min": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 987.65, - "rating_summary": 123.45, + "rating_summary": 987.65, "related_products": [ProductInterface], "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], "url_key": "abc123", "weight": 987.65 @@ -925,8 +926,8 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 987.65, - "sku": "abc123", + "quantity": 123.45, + "sku": "xyz789", "uid": "4" } ``` @@ -956,7 +957,7 @@ Contains details about gift cards added to a requisition list. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "quantity_shipped": 987.65 } ``` @@ -1003,13 +1004,13 @@ A single gift card added to a wish list. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, - "id": "4", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -1031,8 +1032,8 @@ Gift card custom attribute value containing array data. ```json { - "attribute_type": "abc123", - "code": "4", + "attribute_type": "xyz789", + "code": 4, "options": ["abc123"] } ``` @@ -1079,8 +1080,8 @@ Defines a gift message. ```json { - "from": "abc123", - "message": "xyz789", + "from": "xyz789", + "message": "abc123", "to": "abc123" } ``` @@ -1142,11 +1143,11 @@ Contains details about a gift registry. ```json { - "created_at": "abc123", + "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "abc123", + "message": "xyz789", "owner_name": "abc123", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], @@ -1177,7 +1178,7 @@ Contains details about a gift registry. "code": 4, "group": "EVENT_INFORMATION", "label": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1220,7 +1221,10 @@ Defines a dynamic attribute. #### Example ```json -{"code": 4, "value": "xyz789"} +{ + "code": "4", + "value": "xyz789" +} ``` @@ -1246,7 +1250,7 @@ Defines a dynamic attribute. ```json { - "code": "4", + "code": 4, "label": "abc123", "value": "abc123" } @@ -1271,12 +1275,12 @@ Defines a dynamic attribute. ```json { - "attribute_group": "xyz789", - "code": "4", + "attribute_group": "abc123", + "code": 4, "input_type": "abc123", - "is_required": false, + "is_required": true, "label": "abc123", - "sort_order": 123 + "sort_order": 987 } ``` @@ -1305,9 +1309,9 @@ Defines a dynamic attribute. ```json { - "attribute_group": "abc123", - "code": "4", - "input_type": "abc123", + "attribute_group": "xyz789", + "code": 4, + "input_type": "xyz789", "is_required": false, "label": "xyz789", "sort_order": 123 @@ -1333,12 +1337,12 @@ Defines a dynamic attribute. ```json { - "created_at": "abc123", - "note": "abc123", + "created_at": "xyz789", + "note": "xyz789", "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "quantity_fulfilled": 987.65, - "uid": "4" + "uid": 4 } ``` @@ -1371,7 +1375,7 @@ Defines a dynamic attribute. "note": "abc123", "product": ProductInterface, "quantity": 987.65, - "quantity_fulfilled": 123.45, + "quantity_fulfilled": 987.65, "uid": 4 } ``` @@ -1399,7 +1403,7 @@ Contains the status and any errors that encountered with the customer's gift reg ```json { - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1427,8 +1431,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", - "product_uid": 4 + "message": "xyz789", + "product_uid": "4" } ``` @@ -1519,9 +1523,9 @@ Contains details about a registrant. GiftRegistryRegistrantDynamicAttribute ], "email": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -1541,8 +1545,8 @@ Contains details about a registrant. ```json { - "code": 4, - "label": "abc123", + "code": "4", + "label": "xyz789", "value": "abc123" } ``` @@ -1568,12 +1572,12 @@ Contains the results of a gift registry search. ```json { - "event_date": "abc123", - "event_title": "xyz789", + "event_date": "xyz789", + "event_title": "abc123", "gift_registry_uid": "4", - "location": "abc123", - "name": "abc123", - "type": "xyz789" + "location": "xyz789", + "name": "xyz789", + "type": "abc123" } ``` @@ -1668,7 +1672,7 @@ Contains details about the selected or available gift wrapping options. "design": "xyz789", "image": GiftWrappingImage, "price": Money, - "uid": "4" + "uid": 4 } ``` @@ -1690,7 +1694,7 @@ Points to an image associated with a gift wrapping option. ```json { "label": "abc123", - "url": "xyz789" + "url": "abc123" } ``` @@ -1710,9 +1714,9 @@ Points to an image associated with a gift wrapping option. ```json { - "color": "xyz789", + "color": "abc123", "height": 123, - "type": "xyz789" + "type": "abc123" } ``` @@ -1740,11 +1744,11 @@ Points to an image associated with a gift wrapping option. ```json { "button_styles": GooglePayButtonStyles, - "code": "abc123", + "code": "xyz789", "google_pay_mode": "TEST", - "is_visible": false, - "payment_intent": "abc123", - "payment_source": "abc123", + "is_visible": true, + "payment_intent": "xyz789", + "payment_source": "xyz789", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", @@ -1770,7 +1774,7 @@ Google Pay inputs ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } @@ -1854,9 +1858,9 @@ Defines a grouped product, which consists of simple standalone products that are ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1866,38 +1870,38 @@ Defines a grouped product, which consists of simple standalone products that are "image": ProductImage, "is_returnable": "abc123", "items": [GroupedProductItem], - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "abc123", + "meta_keyword": "xyz789", "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "abc123", + "min_sale_qty": 987.65, + "name": "xyz789", "new_from_date": "xyz789", "new_to_date": "abc123", - "only_x_left_in_stock": 123.45, - "options_container": "abc123", + "only_x_left_in_stock": 987.65, + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 123.45 + "url_key": "xyz789", + "weight": 987.65 } ``` @@ -1919,9 +1923,9 @@ Contains information about an individual grouped product item. ```json { - "position": 987, + "position": 123, "product": ProductInterface, - "qty": 987.65 + "qty": 123.45 } ``` @@ -1946,7 +1950,7 @@ A grouped product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", @@ -1972,7 +1976,7 @@ Input to retrieve a guest order based on token. ```json { - "reason": "xyz789", + "reason": "abc123", "token": "xyz789" } ``` @@ -1995,8 +1999,8 @@ Input to retrieve an order based on details. ```json { - "email": "xyz789", - "lastname": "abc123", + "email": "abc123", + "lastname": "xyz789", "number": "abc123" } ``` @@ -2019,8 +2023,8 @@ An object that provides highlighted text for matched words ```json { - "attribute": "abc123", - "matched_words": ["xyz789"], + "attribute": "xyz789", + "matched_words": ["abc123"], "value": "abc123" } ``` @@ -2048,10 +2052,10 @@ Item note data that is added to the negotiable quote history object. { "created_at": "abc123", "creator_name": "abc123", - "creator_type": "xyz789", + "creator_type": "abc123", "item_id": 987, - "note": "xyz789", - "product_name": "abc123" + "note": "abc123", + "product_name": "xyz789" } ``` @@ -2079,17 +2083,17 @@ Item note data that is added to the negotiable quote history object. ```json { - "cc_vault_code": "abc123", + "cc_vault_code": "xyz789", "code": "abc123", "is_vault_enabled": true, - "is_visible": true, + "is_visible": false, "payment_intent": "abc123", "payment_source": "xyz789", "requires_card_details": true, "sdk_params": [SDKParams], "sort_order": "abc123", "three_ds_mode": "OFF", - "title": "abc123" + "title": "xyz789" } ``` @@ -2117,13 +2121,13 @@ Hosted Fields payment inputs ```json { - "cardBin": "abc123", - "cardExpiryMonth": "xyz789", - "cardExpiryYear": "xyz789", - "cardLast4": "xyz789", + "cardBin": "xyz789", + "cardExpiryMonth": "abc123", + "cardExpiryYear": "abc123", + "cardLast4": "abc123", "holderName": "abc123", "is_active_payment_token_enabler": false, - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } @@ -2156,7 +2160,7 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob ```json { - "thumbnail": "xyz789", + "thumbnail": "abc123", "value": "abc123" } ``` @@ -2332,12 +2336,12 @@ Defines an invoice custom attributes. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2399,12 +2403,12 @@ Contains detailes about invoiced items. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -2493,7 +2497,7 @@ Contains the response of a company email validation query. #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2529,7 +2533,7 @@ Contains the response of a company user email validation query. #### Example ```json -{"is_email_available": true} +{"is_email_available": false} ``` @@ -2564,7 +2568,7 @@ Contains the result of the `isEmailAvailable` query. #### Example ```json -{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": false} +{"type": "UNKNOWN_ISOPERATOR_TYPE", "value": true} ``` @@ -2600,7 +2604,7 @@ Response returned when checking whether a customer is subscribed to a product al #### Example ```json -{"isSubscribed": true, "message": "abc123"} +{"isSubscribed": false, "message": "abc123"} ``` @@ -2626,10 +2630,10 @@ The note object for quote line item. ```json { "created_at": "abc123", - "creator_id": 123, + "creator_id": 987, "creator_name": "abc123", "creator_type": 123, - "negotiable_quote_item_uid": 4, + "negotiable_quote_item_uid": "4", "note": "abc123", "note_uid": "4" } @@ -2680,7 +2684,7 @@ A list of values for the selected bundle product. ```json { "price": Money, - "product_name": "abc123", + "product_name": "xyz789", "product_sku": "abc123", "quantity": 987.65, "uid": 4 @@ -2714,7 +2718,7 @@ A JSON scalar ```json { - "key": "xyz789", + "key": "abc123", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2735,9 +2739,9 @@ A JSON scalar ```json { - "key": "xyz789", + "key": "abc123", "message": "xyz789", - "success": false + "success": true } ``` @@ -2777,8 +2781,8 @@ A JSON scalar ```json { - "expires_at": "xyz789", - "key": "abc123", + "expires_at": "abc123", + "key": "xyz789", "upload_url": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md index 5e7c44d73..7ecd3d8a1 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-k-p.md @@ -15,8 +15,8 @@ Contains a key-value pair. ```json { - "name": "xyz789", - "value": "xyz789" + "name": "abc123", + "value": "abc123" } ``` @@ -59,7 +59,7 @@ Sets quote item note. ```json { "note": "xyz789", - "quote_item_uid": "4", + "quote_item_uid": 4, "quote_uid": "4" } ``` @@ -93,10 +93,10 @@ Contains basic information about a product image or video. ```json { - "disabled": false, - "label": "abc123", + "disabled": true, + "label": "xyz789", "position": 123, - "types": ["abc123"], + "types": ["xyz789"], "url": "xyz789" } ``` @@ -138,7 +138,7 @@ Enumeration of media resource types #### Example ```json -{"type": "xyz789"} +{"type": "abc123"} ``` @@ -156,7 +156,7 @@ Enumeration of media resource types ```json { - "layout": "abc123", + "layout": "xyz789", "logo": MessageStyleLogo } ``` @@ -199,7 +199,7 @@ Contains the customer's gift registry and any errors encountered. ```json { "gift_registry": GiftRegistry, - "status": true, + "status": false, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -352,12 +352,12 @@ Contains details about a negotiable quote. "billing_address": NegotiableQuoteBillingAddress, "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", + "created_at": "abc123", "custom_attributes": [CustomAttribute], "email": "abc123", - "expiration_date": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], "name": "xyz789", "order": CustomerOrder, @@ -367,10 +367,10 @@ Contains details about a negotiable quote. "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", "template_id": 4, - "template_name": "abc123", + "template_name": "xyz789", "total_quantity": 123.45, - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } ``` @@ -391,8 +391,8 @@ Defines the company's country. ```json { - "code": "xyz789", - "label": "abc123" + "code": "abc123", + "label": "xyz789" } ``` @@ -429,22 +429,22 @@ Defines the billing or shipping address to be applied to the cart. ```json { "city": "abc123", - "company": "xyz789", + "company": "abc123", "country_code": "xyz789", "custom_attributes": [AttributeValueInput], - "fax": "xyz789", - "firstname": "xyz789", + "fax": "abc123", + "firstname": "abc123", "lastname": "xyz789", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", "prefix": "xyz789", "region": "xyz789", "region_id": 123, - "save_in_address_book": false, + "save_in_address_book": true, "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "xyz789" + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "abc123" } ``` @@ -486,23 +486,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "xyz789", + "city": "abc123", "company": "xyz789", - "company_address_id": 4, + "company_address_id": "4", "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, "fax": "xyz789", - "firstname": "abc123", - "lastname": "xyz789", + "firstname": "xyz789", + "lastname": "abc123", "middlename": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, + "telephone": "abc123", + "uid": "4", "vat_id": "abc123" } ``` @@ -525,9 +525,9 @@ Defines the company's state or province. ```json { - "code": "abc123", + "code": "xyz789", "label": "xyz789", - "region_id": 123 + "region_id": 987 } ``` @@ -563,23 +563,23 @@ Defines the company's state or province. ```json { "city": "abc123", - "company": "abc123", - "company_address_id": "4", + "company": "xyz789", + "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, "fax": "xyz789", "firstname": "abc123", - "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", + "lastname": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, - "vat_id": "xyz789" + "suffix": "abc123", + "telephone": "abc123", + "uid": "4", + "vat_id": "abc123" } ``` @@ -604,7 +604,7 @@ Defines the billing address. ```json { "address": NegotiableQuoteAddressInput, - "company_address_id": 4, + "company_address_id": "4", "customer_address_uid": "4", "same_as_shipping": true, "use_for_shipping": false @@ -659,7 +659,7 @@ Negotiable quote comment file attachment. ```json { "name": "xyz789", - "url": "abc123" + "url": "xyz789" } ``` @@ -738,7 +738,7 @@ Contains custom log entries added by third-party extensions. ```json { - "new_value": "xyz789", + "new_value": "abc123", "old_value": "xyz789", "title": "xyz789" } @@ -838,9 +838,9 @@ Contains details about a change for a negotiable quote. "author": NegotiableQuoteUser, "change_type": "CREATED", "changes": NegotiableQuoteHistoryChanges, - "created_at": "xyz789", + "created_at": "abc123", "item_note": HistoryItemNoteData, - "uid": "4" + "uid": 4 } ``` @@ -881,7 +881,7 @@ Contains a new expiration date and the previous date. ```json { "new_expiration": "xyz789", - "old_expiration": "abc123" + "old_expiration": "xyz789" } ``` @@ -981,7 +981,7 @@ An error indicating that an operation was attempted on a negotiable quote in an #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -1000,7 +1000,7 @@ Specifies the updated quantity of an item. #### Example ```json -{"quantity": 123.45, "quote_item_uid": 4} +{"quantity": 987.65, "quote_item_uid": "4"} ``` @@ -1021,7 +1021,7 @@ Defines the payment method to be applied to the negotiable quote. ```json { "code": "xyz789", - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` @@ -1044,10 +1044,10 @@ Contains a reference document link for a negotiable quote template. ```json { - "document_identifier": "xyz789", - "document_name": "xyz789", + "document_identifier": "abc123", + "document_name": "abc123", "link_id": "4", - "reference_document_url": "abc123" + "reference_document_url": "xyz789" } ``` @@ -1086,13 +1086,13 @@ Contains a reference document link for a negotiable quote template. { "available_shipping_methods": [AvailableShippingMethod], "city": "abc123", - "company": "abc123", + "company": "xyz789", "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": "4", "fax": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "abc123", "middlename": "abc123", "postcode": "abc123", @@ -1102,7 +1102,7 @@ Contains a reference document link for a negotiable quote template. "street": ["abc123"], "suffix": "xyz789", "telephone": "xyz789", - "uid": 4, + "uid": "4", "vat_id": "xyz789" } ``` @@ -1129,7 +1129,7 @@ Defines shipping addresses for the negotiable quote. "address": NegotiableQuoteAddressInput, "company_address_id": "4", "customer_address_uid": "4", - "customer_notes": "xyz789" + "customer_notes": "abc123" } ``` @@ -1240,21 +1240,21 @@ Contains details about a negotiable quote template. "is_min_max_qty_used": false, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 123, + "max_order_commitment": 987, + "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": "abc123", - "template_id": 4, - "total_quantity": 987.65, + "template_id": "4", + "total_quantity": 123.45, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -1317,24 +1317,24 @@ Contains data for a negotiable quote template in a grid. { "activated_at": "xyz789", "company_name": "xyz789", - "created_at": "abc123", - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "is_min_max_qty_used": true, - "last_ordered_at": "xyz789", - "last_shared_at": "abc123", - "max_order_commitment": 987, + "last_ordered_at": "abc123", + "last_shared_at": "xyz789", + "max_order_commitment": 123, "min_negotiated_grand_total": 987.65, - "min_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "orders_placed": 123, "prices": CartPrices, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "state": "abc123", - "status": "xyz789", - "submitted_by": "abc123", + "status": "abc123", + "submitted_by": "xyz789", "template_id": 4, - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } ``` @@ -1391,7 +1391,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" } ``` @@ -1413,7 +1413,7 @@ Lists a new status change applied to a negotiable quote template and the previou ```json { - "new_status": "xyz789", + "new_status": "abc123", "old_status": "xyz789" } ``` @@ -1454,12 +1454,7 @@ Specifies the updated quantity of an item. #### Example ```json -{ - "item_id": "4", - "max_qty": 123.45, - "min_qty": 123.45, - "quantity": 123.45 -} +{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65} ``` @@ -1481,10 +1476,10 @@ Defines the reference document link to add to a negotiable quote template. ```json { - "document_identifier": "abc123", - "document_name": "xyz789", + "document_identifier": "xyz789", + "document_name": "abc123", "link_id": 4, - "reference_document_url": "abc123" + "reference_document_url": "xyz789" } ``` @@ -1572,7 +1567,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1633,7 +1628,7 @@ A limited view of a Buyer or Seller in the negotiable quote process. ```json { - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789" } ``` @@ -1681,7 +1676,7 @@ Contains an error message when an invalid UID was specified. ```json { - "message": "xyz789", + "message": "abc123", "uid": "4" } ``` @@ -1704,7 +1699,7 @@ Error wrapper describing the nomination state of a cart item. ```json { "code": "UNKNOWN_SOURCE", - "message": "xyz789" + "message": "abc123" } ``` @@ -1746,7 +1741,7 @@ A single cart item's source nomination. ```json { - "cart_item_uid": 4, + "cart_item_uid": "4", "source_code": "abc123" } ``` @@ -1804,7 +1799,7 @@ A custom fee applied to the cart by an out-of-process webhook. ```json { "amount": Money, - "code": "xyz789", + "code": "abc123", "label": "xyz789" } ``` @@ -1824,7 +1819,7 @@ A custom fee applied to the cart by an out-of-process webhook. ```json { - "backend_integration_url": "abc123", + "backend_integration_url": "xyz789", "custom_config": [CustomConfigKeyValue] } ``` @@ -1844,7 +1839,7 @@ Specifies the quote template id to open quote template. #### Example ```json -{"template_id": "4"} +{"template_id": 4} ``` @@ -1860,6 +1855,8 @@ Specifies the quote template id to open quote template. | `isOperator` - [`IsOperatorInput`](/reference/graphql/saas/types-f-i.md#isoperatorinput) | | | `numericOperator` - [`NumericOperatorInput`](#numericoperatorinput) | | | `stringOperator` - [`StringOperatorInput`](/reference/graphql/saas/types-q-s.md#stringoperatorinput) | | +| `attributeStringOperator` - [`AttributeStringOperatorInput`](/reference/graphql/saas/types-a-b.md#attributestringoperatorinput) | | +| `attributeRangeOperator` - [`AttributeRangeOperatorInput`](/reference/graphql/saas/types-a-b.md#attributerangeoperatorinput) | | #### Example @@ -1869,7 +1866,9 @@ Specifies the quote template id to open quote template. "customOperator": CustomOperatorInput, "isOperator": IsOperatorInput, "numericOperator": NumericOperatorInput, - "stringOperator": StringOperatorInput + "stringOperator": StringOperatorInput, + "attributeStringOperator": AttributeStringOperatorInput, + "attributeRangeOperator": AttributeRangeOperatorInput } ``` @@ -1943,17 +1942,17 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "city": "xyz789", - "company": "xyz789", - "company_address_id": 4, + "city": "abc123", + "company": "abc123", + "company_address_id": "4", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "fax": "abc123", + "fax": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "middlename": "abc123", - "postcode": "abc123", - "prefix": "xyz789", + "middlename": "xyz789", + "postcode": "xyz789", + "prefix": "abc123", "region": "abc123", "region_id": 4, "street": ["abc123"], @@ -2033,23 +2032,23 @@ Contains detailed information about an order's billing and shipping addresses. "free_gift_label": "abc123", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", "product_type": "xyz789", - "product_url_key": "abc123", - "quantity_canceled": 987.65, + "product_url_key": "xyz789", + "quantity_canceled": 123.45, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, - "quantity_refunded": 123.45, + "quantity_refunded": 987.65, "quantity_return_requested": 123.45, - "quantity_returned": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -2112,18 +2111,18 @@ Order item details. "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "product_type": "abc123", - "product_url_key": "abc123", + "product_url_key": "xyz789", "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, "quantity_refunded": 123.45, - "quantity_return_requested": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], "status": "xyz789" } @@ -2209,7 +2208,7 @@ Contains details about the payment method used to pay for the order. { "additional_data": [KeyValue], "name": "abc123", - "type": "abc123" + "type": "xyz789" } ``` @@ -2234,7 +2233,7 @@ Contains order shipment details. ```json { "comments": [SalesCommentItem], - "id": "4", + "id": 4, "items": [ShipmentItemInterface], "number": "xyz789", "tracking": [ShipmentTracking] @@ -2343,7 +2342,7 @@ Result of payByLinkCart. #### Example ```json -{"masked_cart_id": "xyz789"} +{"masked_cart_id": "abc123"} ``` @@ -2491,7 +2490,7 @@ Defines the payment method. "payment_services_paypal_hosted_fields": HostedFieldsInput, "payment_services_paypal_smart_buttons": SmartButtonMethodInput, "payment_services_paypal_vault": VaultMethodInput, - "purchase_order_number": "abc123" + "purchase_order_number": "xyz789" } ``` @@ -2612,8 +2611,8 @@ The stored payment method available to the customer. ```json { - "details": "abc123", - "payment_method_code": "abc123", + "details": "xyz789", + "payment_method_code": "xyz789", "public_hash": "abc123", "type": "card" } @@ -2698,19 +2697,19 @@ Defines Pickup Location information. { "city": "abc123", "contact_name": "xyz789", - "country_id": "abc123", - "description": "abc123", - "email": "xyz789", - "fax": "xyz789", - "latitude": 987.65, - "longitude": 123.45, + "country_id": "xyz789", + "description": "xyz789", + "email": "abc123", + "fax": "abc123", + "latitude": 123.45, + "longitude": 987.65, "name": "abc123", - "phone": "abc123", + "phone": "xyz789", "pickup_location_code": "abc123", "postcode": "xyz789", - "region": "xyz789", - "region_id": 987, - "street": "xyz789" + "region": "abc123", + "region_id": 123, + "street": "abc123" } ``` @@ -2898,7 +2897,7 @@ An error encountered while placing an order. ```json { "code": "CART_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -3013,7 +3012,7 @@ Specifies the quote to be converted to a purchase order. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -3094,8 +3093,8 @@ 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_price": 987.65 + "main_final_price": 987.65, + "main_price": 123.45 } ``` @@ -3175,7 +3174,7 @@ Input to identify a product by SKU for a price alert subscription. #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3212,7 +3211,7 @@ Response returned after a product alert subscribe or unsubscribe mutation. #### Example ```json -{"message": "abc123", "success": false} +{"message": "abc123", "success": true} ``` @@ -3255,9 +3254,9 @@ Contains a product attribute code and value. ```json { "attribute_type": "abc123", - "code": "4", - "url": "abc123", - "value": "xyz789" + "code": 4, + "url": "xyz789", + "value": "abc123" } ``` @@ -3299,7 +3298,7 @@ Contains the discount applied to a product price. #### Example ```json -{"amount_off": 123.45, "percent_off": 987.65} +{"amount_off": 123.45, "percent_off": 123.45} ``` @@ -3322,8 +3321,8 @@ Contains product image information, including the image URL and label. ```json { - "disabled": true, - "label": "abc123", + "disabled": false, + "label": "xyz789", "position": 123, "types": ["xyz789"], "url": "xyz789" @@ -3362,7 +3361,7 @@ Product Information used for Pickup Locations search. #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3434,42 +3433,42 @@ Contains fields that are common to all types of products. ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "xyz789", + "meta_description": "abc123", + "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 123.45, - "name": "xyz789", - "new_from_date": "xyz789", + "min_sale_qty": 987.65, + "name": "abc123", + "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, - "options_container": "xyz789", + "only_x_left_in_stock": 123.45, + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, - "rating_summary": 123.45, + "quantity": 987.65, + "rating_summary": 987.65, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 987.65, - "special_to_date": "xyz789", + "special_price": 123.45, + "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, @@ -3499,11 +3498,11 @@ An implementation of `ProductLinksInterface`. ```json { - "link_type": "abc123", - "linked_product_sku": "abc123", - "linked_product_type": "xyz789", + "link_type": "xyz789", + "linked_product_sku": "xyz789", + "linked_product_type": "abc123", "position": 987, - "sku": "xyz789" + "sku": "abc123" } ``` @@ -3584,8 +3583,8 @@ Contains basic information about the video asset. ```json { "media_type": "abc123", - "video_asset_id": "xyz789", - "video_media_url": "abc123" + "video_asset_id": "abc123", + "video_media_url": "xyz789" } ``` @@ -3614,8 +3613,8 @@ Contains a link to a video file and basic information about the video. "video_description": "xyz789", "video_metadata": "abc123", "video_provider": "xyz789", - "video_title": "abc123", - "video_url": "xyz789" + "video_title": "xyz789", + "video_url": "abc123" } ``` @@ -3668,8 +3667,8 @@ Contains details of a product review. ```json { "average_rating": 123.45, - "created_at": "abc123", - "nickname": "abc123", + "created_at": "xyz789", + "nickname": "xyz789", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], "summary": "xyz789", @@ -3695,7 +3694,7 @@ Contains data about a single aspect of a product review. ```json { "name": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -3717,7 +3716,7 @@ Contains the reviewer's rating for a single aspect of a review. ```json { "id": "abc123", - "value_id": "xyz789" + "value_id": "abc123" } ``` @@ -3740,7 +3739,7 @@ Contains details about a single aspect of a product review. ```json { "id": "abc123", - "name": "abc123", + "name": "xyz789", "values": [ProductReviewRatingValueMetadata] } ``` @@ -3762,7 +3761,7 @@ Contains details about a single value in a product review. ```json { - "value": "xyz789", + "value": "abc123", "value_id": "xyz789" } ``` @@ -3856,8 +3855,8 @@ Contains the output of a `productSearch` query "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["abc123"], - "suggestions": ["xyz789"], + "related_terms": ["xyz789"], + "suggestions": ["abc123"], "total_count": 987, "warnings": [ProductSearchWarning] } @@ -3879,7 +3878,7 @@ The product attribute to sort on #### Example ```json -{"attribute": "abc123", "direction": "ASC"} +{"attribute": "xyz789", "direction": "ASC"} ``` @@ -3899,7 +3898,7 @@ Structured warning with code and message for easier client handling ```json { - "code": "abc123", + "code": "xyz789", "message": "abc123" } ``` @@ -3945,10 +3944,10 @@ Contains information about a product video. ```json { "disabled": false, - "label": "xyz789", - "position": 987, - "types": ["abc123"], - "url": "xyz789", + "label": "abc123", + "position": 123, + "types": ["xyz789"], + "url": "abc123", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -4002,25 +4001,25 @@ Defines the product fields available to the SimpleProductView and ComplexProduct "inStock": true, "lowStock": true, "attributes": [ProductViewAttribute], - "description": "abc123", - "id": 4, + "description": "xyz789", + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", + "metaDescription": "xyz789", "metaKeyword": "xyz789", - "metaTitle": "xyz789", - "name": "abc123", + "metaTitle": "abc123", + "name": "xyz789", "shortDescription": "xyz789", "inputOptions": [ProductViewInputOption], "sku": "abc123", - "externalId": "abc123", + "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", + "url": "abc123", "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "xyz789", - "visibility": "abc123" + "queryType": "abc123", + "visibility": "xyz789" } ``` @@ -4045,7 +4044,7 @@ A container for customer-defined attributes that are displayed the storefront. { "label": "xyz789", "name": "xyz789", - "roles": ["abc123"], + "roles": ["xyz789"], "value": {} } ``` @@ -4255,8 +4254,8 @@ Contains details about a product image. ```json { - "label": "xyz789", - "roles": ["abc123"], + "label": "abc123", + "roles": ["xyz789"], "url": "abc123" } ``` @@ -4286,16 +4285,16 @@ Product options provide a way to configure products by making selections of part ```json { - "id": "4", + "id": 4, "title": "xyz789", - "required": true, - "type": "xyz789", - "markupAmount": 987.65, - "suffix": "xyz789", - "sortOrder": 123, + "required": false, + "type": "abc123", + "markupAmount": 123.45, + "suffix": "abc123", + "sortOrder": 987, "range": ProductViewInputOptionRange, "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "abc123" + "fileExtensions": "xyz789" } ``` @@ -4334,7 +4333,7 @@ Lists the value range associated with a `ProductViewInputOption`. For example, i #### Example ```json -{"from": 123.45, "to": 987.65} +{"from": 987.65, "to": 123.45} ``` @@ -4401,7 +4400,7 @@ Product options provide a way to configure products by making selections of part "id": 4, "multi": false, "required": false, - "title": "xyz789", + "title": "abc123", "values": [ProductViewOptionValue] } ``` @@ -4433,7 +4432,7 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr ```json { "id": 4, - "title": "xyz789", + "title": "abc123", "inStock": true } ``` @@ -4457,7 +4456,7 @@ An implementation of ProductViewOptionValue for configuration values. ```json { "id": 4, - "title": "abc123", + "title": "xyz789", "inStock": true } ``` @@ -4484,13 +4483,13 @@ An implementation of ProductViewOptionValue that adds details about a simple pro ```json { - "id": "4", + "id": 4, "isDefault": false, "product": SimpleProductView, - "quantity": 987.65, + "quantity": 123.45, "canEditQuantity": true, "title": "xyz789", - "inStock": false + "inStock": true } ``` @@ -4515,7 +4514,7 @@ An implementation of ProductViewOptionValueSwatch for swatches. ```json { "id": 4, - "title": "abc123", + "title": "xyz789", "type": "TEXT", "value": "xyz789", "inStock": true @@ -4544,7 +4543,7 @@ Base product price view. Contains the final price after discounts, the regular p "final": Price, "regular": Price, "tiers": [ProductViewTierPrice], - "roles": ["abc123"] + "roles": ["xyz789"] } ``` @@ -4643,7 +4642,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, #### Example ```json -{"gte": 987.65, "lt": 987.65} +{"gte": 123.45, "lt": 987.65} ``` @@ -4663,7 +4662,7 @@ Represents a product variant. ```json { - "selections": ["xyz789"], + "selections": ["abc123"], "product": ProductView } ``` @@ -4711,13 +4710,82 @@ Contains details about a product video. For example, a video of the product bein { "preview": ProductViewImage, "url": "abc123", - "description": "xyz789", - "title": "xyz789" + "description": "abc123", + "title": "abc123" } ``` +### PublicRequisitionListOutput + +Contains a public requisition list and its owner's display name. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `requisition_list` - [`RequisitionList!`](/reference/graphql/saas/types-q-s.md#requisitionlist) | The shared requisition list and its items. | +| `sender_name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | Display name of the requisition list owner (sender). | + +#### Example + +```json +{ + "requisition_list": RequisitionList, + "sender_name": "abc123" +} +``` + + + +### PublicRequisitionListUserError + +Contains error details for a failed public requisition list operation. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `code` - [`PublicRequisitionListUserErrorCode!`](#publicrequisitionlistusererrorcode) | An error code identifying the failure type. | +| `message` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | A localized error message. | + +#### Example + +```json +{"code": "NOT_PUBLIC", "message": "abc123"} +``` + + + +### PublicRequisitionListUserErrorCode + +Error codes for public requisition list operations. + +#### Values + +| Enum Value | Description | +|------------|-------------| +| `NOT_PUBLIC` | | +| `INVALID_TOKEN` | | +| `RESTRICTED_PRODUCT` | | +| `MAX_RECIPIENTS_EXCEEDED` | | +| `RATE_LIMIT_EXCEEDED` | | +| `INVALID_EMAIL` | | +| `UNAVAILABLE_SKU` | | +| `OPTIONS_UPDATED` | | +| `OUT_OF_STOCK` | | +| `LOW_QUANTITY` | | +| `UNKNOWN_ERROR` | | + +#### Example + +```json +""NOT_PUBLIC"" +``` + + + ### PurchaseHistory User purchase history @@ -4841,9 +4909,9 @@ Contains details about a single event in the approval flow of the purchase order { "message": "abc123", "name": "abc123", - "role": "abc123", + "role": "xyz789", "status": "PENDING", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -4894,12 +4962,12 @@ Contains details about a purchase order approval rule. "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", - "created_by": "xyz789", + "created_by": "abc123", "description": "abc123", - "name": "xyz789", + "name": "abc123", "status": "ENABLED", - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } ``` @@ -5014,10 +5082,10 @@ Defines a new purchase order approval rule. ```json { "applies_to": [4], - "approvers": [4], + "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", - "name": "xyz789", + "name": "abc123", "status": "ENABLED" } ``` @@ -5101,7 +5169,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5125,9 +5193,9 @@ Contains details about a comment. ```json { "author": Customer, - "created_at": "abc123", + "created_at": "xyz789", "text": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -5195,7 +5263,7 @@ Contains details about approval roles applied to the purchase order and status c ```json { "events": [PurchaseOrderApprovalFlowEvent], - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -5243,7 +5311,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5310,7 +5378,7 @@ Defines the criteria to use to filter the list of purchase orders. "company_purchase_orders": true, "created_date": FilterRangeTypeInput, "my_approvals": true, - "require_my_approval": true, + "require_my_approval": false, "status": "PENDING" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md index e28e91062..10f82d0e8 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-q-s.md @@ -54,8 +54,8 @@ Sets quote template expiration date. ```json { - "expiration_date": "abc123", - "template_id": "4" + "expiration_date": "xyz789", + "template_id": 4 } ``` @@ -80,8 +80,8 @@ Sets quote item note. { "item_id": 4, "item_uid": 4, - "note": "abc123", - "templateId": "4" + "note": "xyz789", + "templateId": 4 } ``` @@ -102,7 +102,7 @@ Contains a notification message for a negotiable quote template. ```json { - "message": "xyz789", + "message": "abc123", "type": "xyz789" } ``` @@ -129,7 +129,7 @@ For use on numeric product fields "count": 987, "from": 123.45, "title": "xyz789", - "to": 987.65 + "to": 123.45 } ``` @@ -230,10 +230,10 @@ Contains reCAPTCHA form configuration details. ```json { "badge_position": "xyz789", - "language_code": "xyz789", + "language_code": "abc123", "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", - "technical_failure_message": "xyz789", + "technical_failure_message": "abc123", "theme": "abc123", "validation_failure_message": "abc123", "website_key": "abc123" @@ -263,14 +263,14 @@ Contains reCAPTCHA V3-Invisible configuration details. ```json { - "badge_position": "xyz789", - "failure_message": "abc123", + "badge_position": "abc123", + "failure_message": "xyz789", "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 123.45, - "theme": "xyz789", - "website_key": "xyz789" + "is_enabled": false, + "language_code": "abc123", + "minimum_score": 987.65, + "theme": "abc123", + "website_key": "abc123" } ``` @@ -370,13 +370,13 @@ Recommendation Unit containing product and other details ```json { "displayOrder": 987, - "pageType": "abc123", + "pageType": "xyz789", "productsView": [ProductView], - "storefrontLabel": "xyz789", - "totalProducts": 987, - "typeId": "abc123", - "unitId": "xyz789", - "unitName": "xyz789", + "storefrontLabel": "abc123", + "totalProducts": 123, + "typeId": "xyz789", + "unitId": "abc123", + "unitName": "abc123", "label": "xyz789", "userError": "abc123" } @@ -398,7 +398,7 @@ Recommendations response #### Example ```json -{"results": [RecommendationUnit], "totalResults": 987} +{"results": [RecommendationUnit], "totalResults": 123} ``` @@ -419,7 +419,7 @@ Recommendations response { "code": "abc123", "id": 987, - "name": "xyz789" + "name": "abc123" } ``` @@ -443,8 +443,8 @@ A single cart item whose source nomination was rejected. ```json { - "available_qty": 987.65, - "cart_item_uid": 4, + "available_qty": 123.45, + "cart_item_uid": "4", "code": "UNKNOWN_SOURCE", "message": "xyz789", "requested_qty": 123.45 @@ -466,7 +466,7 @@ Specifies the cart from which to remove a coupon. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -505,7 +505,7 @@ Remove coupons from the cart. ```json { "cart_id": "abc123", - "coupon_codes": ["xyz789"] + "coupon_codes": ["abc123"] } ``` @@ -582,7 +582,7 @@ Contains the results of a request to delete a gift registry. #### Example ```json -{"success": true} +{"success": false} ``` @@ -619,10 +619,7 @@ Specifies which items to remove from the cart. #### Example ```json -{ - "cart_id": "xyz789", - "cart_item_uid": "4" -} +{"cart_id": "xyz789", "cart_item_uid": 4} ``` @@ -659,7 +656,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} ``` @@ -696,7 +693,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"} ``` @@ -715,10 +712,7 @@ Defines which products to remove from a compare list. #### Example ```json -{ - "products": ["4"], - "uid": "4" -} +{"products": [4], "uid": 4} ``` @@ -812,7 +806,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -852,8 +846,8 @@ Sets new name for a negotiable quote. ```json { "quote_comment": "abc123", - "quote_name": "xyz789", - "quote_uid": "4" + "quote_name": "abc123", + "quote_uid": 4 } ``` @@ -916,10 +910,10 @@ Contains information needed to start a return request. ```json { - "comment_text": "abc123", - "contact_email": "xyz789", + "comment_text": "xyz789", + "contact_email": "abc123", "items": [RequestReturnItemInput], - "token": "xyz789" + "token": "abc123" } ``` @@ -1005,7 +999,7 @@ Contains information needed to start a return request. ```json { "comment_text": "xyz789", - "contact_email": "abc123", + "contact_email": "xyz789", "items": [RequestReturnItemInput], "order_uid": "4" } @@ -1033,7 +1027,7 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": "4", + "order_item_uid": 4, "quantity_to_return": 987.65, "selected_custom_attributes": [ SelectedCustomAttributeInput @@ -1074,10 +1068,12 @@ Defines the contents of a requisition list. | Field Name | Description | |------------|-------------| | `description` - [`String`](#string) | Optional text that describes the requisition list. | +| `is_public` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether this requisition list is currently publicly shareable. Defaults to false. | | `items` - [`RequistionListItems`](#requistionlistitems) | An array of products added to the requisition list. *(Deprecated: Deprecated. Use requisition_list_items instead. Will be removed in a future release.)* | | `items_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of items in the list. | | `name` - [`String!`](#string) | The requisition list name. | | `requisition_list_items` - [`RequisitionListItems`](#requisitionlistitems) | An array of products added to the requisition list. | +| `token` - [`ID`](/reference/graphql/saas/types-f-i.md#id) | The list's public share token. Only resolved for the authenticated owner querying their own list; null for all other viewers, even when is_public is true. | | `uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique requisition list ID. | | `updated_at` - [`String`](#string) | The time of the last modification of the requisition list. | @@ -1086,10 +1082,12 @@ Defines the contents of a requisition list. ```json { "description": "abc123", + "is_public": true, "items": RequistionListItems, - "items_count": 987, - "name": "xyz789", + "items_count": 123, + "name": "abc123", "requisition_list_items": RequisitionListItems, + "token": "4", "uid": 4, "updated_at": "xyz789" } @@ -1151,8 +1149,8 @@ The interface for requisition list items. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "abc123", - "uid": 4 + "sku": "xyz789", + "uid": "4" } ``` @@ -1202,9 +1200,9 @@ Defines the items to add. { "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", - "quantity": 123.45, - "selected_options": ["xyz789"], - "sku": "xyz789" + "quantity": 987.65, + "selected_options": ["abc123"], + "sku": "abc123" } ``` @@ -1266,7 +1264,7 @@ Defines customer requisition lists. "items": [RequisitionList], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } ``` @@ -1290,7 +1288,7 @@ Deprecated. Use RequisitionListItems via requisition_list_items. Will be removed { "items": [RequisitionListItemInterface], "page_info": SearchResultPageInfo, - "total_pages": 123 + "total_pages": 987 } ``` @@ -1321,14 +1319,14 @@ Contains details about a return. { "available_shipping_carriers": [ReturnShippingCarrier], "comments": [ReturnComment], - "created_at": "xyz789", + "created_at": "abc123", "customer": ReturnCustomer, "items": [ReturnItem], - "number": "abc123", + "number": "xyz789", "order": CustomerOrder, "shipping": ReturnShipping, "status": "PENDING", - "uid": 4 + "uid": "4" } ``` @@ -1353,8 +1351,8 @@ Contains details about a return comment. { "author_name": "abc123", "created_at": "abc123", - "text": "abc123", - "uid": "4" + "text": "xyz789", + "uid": 4 } ``` @@ -1440,16 +1438,16 @@ Return Item attribute metadata. ```json { - "code": "4", + "code": 4, "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "xyz789", + "frontend_class": "abc123", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": false, + "is_required": true, "is_unique": false, "label": "xyz789", - "multiline_count": 987, + "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 987, "validate_rules": [ValidationRule] @@ -1521,10 +1519,10 @@ Contains details about the shipping address used for receiving returned items. ```json { - "city": "xyz789", - "contact_name": "abc123", + "city": "abc123", + "contact_name": "xyz789", "country": Country, - "postcode": "xyz789", + "postcode": "abc123", "region": Region, "street": ["xyz789"], "telephone": "abc123" @@ -1547,7 +1545,10 @@ Contains details about the carrier on a return. #### Example ```json -{"label": "abc123", "uid": 4} +{ + "label": "abc123", + "uid": "4" +} ``` @@ -1571,8 +1572,8 @@ Contains shipping and tracking details. { "carrier": ReturnShippingCarrier, "status": ReturnShippingTrackingStatus, - "tracking_number": "abc123", - "uid": "4" + "tracking_number": "xyz789", + "uid": 4 } ``` @@ -1660,7 +1661,7 @@ Contains a list of customer return requests. { "items": [Return], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -1679,7 +1680,7 @@ Contains the result of a request to revoke a customer token. #### Example ```json -{"result": true} +{"result": false} ``` @@ -1722,7 +1723,7 @@ Contains details about a customer's reward points. #### Example ```json -{"money": Money, "points": 123.45} +{"money": Money, "points": 987.65} ``` @@ -1745,9 +1746,9 @@ Contain details about the reward points transaction. ```json { "balance": RewardPointsAmount, - "change_reason": "abc123", - "date": "abc123", - "points_change": 987.65 + "change_reason": "xyz789", + "date": "xyz789", + "points_change": 123.45 } ``` @@ -1789,7 +1790,7 @@ Contains details about customer's reward points rate. #### Example ```json -{"currency_amount": 123.45, "points": 123.45} +{"currency_amount": 123.45, "points": 987.65} ``` @@ -1848,8 +1849,8 @@ Defines the name and value of a SDK parameter ```json { - "name": "abc123", - "value": "xyz789" + "name": "xyz789", + "value": "abc123" } ``` @@ -1892,7 +1893,7 @@ For use on string and other scalar product fields #### Example ```json -{"count": 123, "id": 4, "title": "abc123"} +{"count": 987, "id": 4, "title": "abc123"} ``` @@ -1936,12 +1937,12 @@ A product attribute to filter on ```json { - "attribute": "xyz789", + "attribute": "abc123", "contains": "xyz789", - "eq": "xyz789", + "eq": "abc123", "in": ["xyz789"], "range": SearchRangeInput, - "startsWith": "abc123" + "startsWith": "xyz789" } ``` @@ -1961,7 +1962,7 @@ A range of numeric values for use in a search #### Example ```json -{"from": 123.45, "to": 987.65} +{"from": 123.45, "to": 123.45} ``` @@ -1981,7 +1982,7 @@ Provides navigation for the query response. #### Example ```json -{"current_page": 123, "page_size": 987, "total_pages": 123} +{"current_page": 123, "page_size": 123, "total_pages": 123} ``` @@ -2005,7 +2006,7 @@ Provides navigation for the query response. { "cart_id": "xyz789", "entered_options": [EnteredOptionInput], - "quantity": 123, + "quantity": 987, "rule_id": 987, "selected_options": [4], "sku": "xyz789" @@ -2074,7 +2075,7 @@ Contains details about a value for a selected bundle option. ```json { - "label": "abc123", + "label": "xyz789", "original_price": Money, "priceV2": Money, "quantity": 123.45, @@ -2101,10 +2102,10 @@ Contains details about a selected configurable option. ```json { - "configurable_product_option_uid": 4, - "configurable_product_option_value_uid": "4", - "option_label": "xyz789", - "value_label": "abc123" + "configurable_product_option_uid": "4", + "configurable_product_option_value_uid": 4, + "option_label": "abc123", + "value_label": "xyz789" } ``` @@ -2125,7 +2126,7 @@ Contains details about an attribute the buyer selected. ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "value": "xyz789" } ``` @@ -2151,9 +2152,9 @@ Identifies a customized product that has been placed in a cart. ```json { - "customizable_option_uid": "4", + "customizable_option_uid": 4, "is_required": false, - "label": "xyz789", + "label": "abc123", "sort_order": 123, "type": "xyz789", "values": [SelectedCustomizableOptionValue] @@ -2180,7 +2181,7 @@ Identifies the value of the selected customized option. ```json { "customizable_option_value_uid": "4", - "label": "abc123", + "label": "xyz789", "price": CartItemSelectedOptionValuePrice, "value": "xyz789" } @@ -2205,7 +2206,7 @@ Describes the payment method selected by the shopper. ```json { - "code": "abc123", + "code": "xyz789", "oope_payment_method_config": OopePaymentMethodConfig, "purchase_order_number": "xyz789", "title": "xyz789" @@ -2237,9 +2238,9 @@ Contains details about the selected shipping method and carrier. { "additional_data": [ShippingAdditionalData], "amount": Money, - "carrier_code": "abc123", - "carrier_title": "xyz789", - "method_code": "xyz789", + "carrier_code": "xyz789", + "carrier_title": "abc123", + "method_code": "abc123", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -2262,10 +2263,7 @@ Specifies which negotiable quote to send for review. #### Example ```json -{ - "comment": NegotiableQuoteCommentInput, - "quote_uid": "4" -} +{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} ``` @@ -2304,7 +2302,7 @@ Sets the billing address. ```json { "billing_address": BillingAddressInput, - "cart_id": "abc123" + "cart_id": "xyz789" } ``` @@ -2342,7 +2340,7 @@ Sets the cart as inactive #### Example ```json -{"error": "abc123", "success": true} +{"error": "xyz789", "success": true} ``` @@ -2445,8 +2443,8 @@ Defines the gift options applied to the cart. "cart_id": "abc123", "gift_message": GiftMessageInput, "gift_receipt_included": true, - "gift_wrapping_id": 4, - "printed_card_included": true + "gift_wrapping_id": "4", + "printed_card_included": false } ``` @@ -2486,7 +2484,7 @@ Defines the guest email and cart. ```json { "cart_id": "xyz789", - "email": "xyz789" + "email": "abc123" } ``` @@ -2584,7 +2582,7 @@ Defines the payment method of the specified negotiable quote. ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -2623,7 +2621,7 @@ Defines the shipping address to assign to the negotiable quote. ```json { - "quote_uid": 4, + "quote_uid": "4", "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2771,7 +2769,7 @@ Applies a payment method to the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "payment_method": PaymentMethodInput } ``` @@ -2932,7 +2930,51 @@ Defines the sender of an invitation to view a gift registry. ```json { "message": "abc123", - "name": "xyz789" + "name": "abc123" +} +``` + + + +### SharePublicRequisitionListInput + +An input object that identifies the requisition list to share and the email addresses to send it to. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `emails` - [`[String]!`](#string) | One or more recipient email addresses. Not limited to registered customers. | +| `requisition_list_uid` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The unique UID of the requisition list to share. | + +#### Example + +```json +{ + "emails": ["abc123"], + "requisition_list_uid": "4" +} +``` + + + +### SharePublicRequisitionListOutput + +Contains the number of emails successfully sent and any errors encountered. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `sent_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Number of emails successfully sent. | +| `user_errors` - [`[PublicRequisitionListUserError]!`](/reference/graphql/saas/types-k-p.md#publicrequisitionlistusererror) | Errors encountered, e.g. NOT_PUBLIC when the list has not been marked public. | + +#### Example + +```json +{ + "sent_count": 123, + "user_errors": [PublicRequisitionListUserError] } ``` @@ -2952,10 +2994,7 @@ An input object that defines which requisition list shared with company users th #### Example ```json -{ - "customerUids": [4], - "requisitionListUid": "4" -} +{"customerUids": [4], "requisitionListUid": 4} ``` @@ -2975,7 +3014,7 @@ Result of sharing a requisition list by email. ```json { - "sent_count": 123, + "sent_count": 987, "user_errors": [ShareRequisitionListUserError] } ``` @@ -2995,7 +3034,7 @@ The result of sharing a requisition list by token. #### Example ```json -{"token": "xyz789"} +{"token": "abc123"} ``` @@ -3103,10 +3142,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": 123.45 + "quantity_shipped": 987.65 } ``` @@ -3139,12 +3178,12 @@ Order shipment item details. ```json { - "id": "4", + "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", - "quantity_shipped": 987.65 + "product_sku": "abc123", + "quantity_shipped": 123.45 } ``` @@ -3167,10 +3206,10 @@ Contains order shipment tracking details. ```json { - "carrier": "abc123", - "number": "abc123", - "title": "xyz789", - "tracking_url": "abc123" + "carrier": "xyz789", + "number": "xyz789", + "title": "abc123", + "tracking_url": "xyz789" } ``` @@ -3191,8 +3230,8 @@ A simple key value object. ```json { - "key": "xyz789", - "value": "xyz789" + "key": "abc123", + "value": "abc123" } ``` @@ -3220,8 +3259,8 @@ Defines a single shipping address. "address": CartAddressInput, "company_address_id": 4, "customer_address_id": 123, - "customer_address_uid": "4", - "customer_notes": "abc123", + "customer_address_uid": 4, + "customer_notes": "xyz789", "pickup_location_code": "xyz789" } ``` @@ -3273,23 +3312,23 @@ Contains shipping addresses and methods. "company_address_id": "4", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", + "customer_address_uid": 4, "customer_notes": "xyz789", - "fax": "abc123", - "firstname": "abc123", - "id": 987, + "fax": "xyz789", + "firstname": "xyz789", + "id": 123, "lastname": "xyz789", "middlename": "xyz789", - "pickup_location_code": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "pickup_location_code": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, "street": ["xyz789"], "suffix": "xyz789", - "telephone": "abc123", - "uid": "4", + "telephone": "xyz789", + "uid": 4, "vat_id": "abc123" } ``` @@ -3410,7 +3449,7 @@ An implementation for simple product cart items. "is_available": false, "is_free_gift": true, "is_salable": false, - "max_qty": 987.65, + "max_qty": 123.45, "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], @@ -3419,8 +3458,8 @@ An implementation for simple product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -3485,23 +3524,23 @@ Defines a simple product, which is tangible and is usually sold in single units { "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": false, - "gift_wrapping_available": false, + "gift_message_available": true, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "manufacturer": 123, "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], "meta_description": "xyz789", "meta_keyword": "xyz789", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", + "name": "xyz789", "new_from_date": "xyz789", "new_to_date": "abc123", "only_x_left_in_stock": 123.45, @@ -3511,19 +3550,19 @@ Defines a simple product, which is tangible and is usually sold in single units "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 987.65, - "rating_summary": 987.65, + "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "xyz789", + "special_price": 987.65, + "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], "url_key": "xyz789", "weight": 987.65 @@ -3573,26 +3612,26 @@ Represents a single-SKU product without selectable variants. Because there are n "inStock": false, "lowStock": false, "attributes": [ProductViewAttribute], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "abc123", + "metaDescription": "xyz789", + "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "xyz789", + "name": "abc123", "price": ProductViewPrice, - "shortDescription": "xyz789", - "sku": "xyz789", + "shortDescription": "abc123", + "sku": "abc123", "externalId": "xyz789", "externalIds": [ExternalId], - "url": "abc123", + "url": "xyz789", "urlKey": "abc123", "links": [ProductViewLink], "queryType": "abc123", - "visibility": "abc123" + "visibility": "xyz789" } ``` @@ -3619,7 +3658,7 @@ Contains details about simple products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 987.65, - "sku": "abc123", + "sku": "xyz789", "uid": "4" } ``` @@ -3645,7 +3684,7 @@ Contains a simple product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "id": 4, @@ -3664,14 +3703,18 @@ Per-source availability for a single SKU across the sources of the current sales | Field Name | Description | |------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing pre-order notice, populated only when the SKU is saleable solely because notify-mode backorders are enabled and salable quantity is depleted (net of open reservations and the out-of-stock threshold); null otherwise (salable quantity remaining, silent backorders, or not saleable). | +| `is_saleable` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the SKU can be purchased right now, backorders considered: true when it is in stock, or out of stock with backorders enabled. This is the authoritative Add to Cart gate — gate on this, not on the per-source is_in_stock (which is a physical-inventory statement). Returned for every reported SKU regardless of whether per-source disclosure is enabled for the store; an unknown SKU, or one hidden from the shopper's catalog, is not reported at all. | | `sku` - [`String!`](#string) | The product SKU the availability applies to. | -| `sources` - [`[SourceAvailability]!`](#sourceavailability) | Availability at each reported source. | +| `sources` - [`[SourceAvailability]!`](#sourceavailability) | Availability at each reported source. Empty when per-source disclosure is not enabled for the store (cataloginventory/source_availability/storefront_enabled off); is_saleable and backorder_message are still returned. | #### Example ```json { - "sku": "xyz789", + "backorder_message": "xyz789", + "is_saleable": true, + "sku": "abc123", "sources": [SourceAvailability] } ``` @@ -3728,12 +3771,12 @@ Smart button payment inputs "button_styles": ButtonStyles, "code": "abc123", "display_message": false, - "display_venmo": true, + "display_venmo": false, "is_visible": false, "message_styles": MessageStyles, "payment_intent": "abc123", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "abc123" } ``` @@ -3774,8 +3817,8 @@ Defines a possible sort field. ```json { - "label": "xyz789", - "value": "xyz789" + "label": "abc123", + "value": "abc123" } ``` @@ -3796,7 +3839,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "xyz789", + "default": "abc123", "options": [SortField] } ``` @@ -3870,10 +3913,10 @@ Contains product attributes that be used for sorting in a `productSearch` query ```json { - "attribute": "xyz789", - "frontendInput": "xyz789", + "attribute": "abc123", + "frontendInput": "abc123", "label": "abc123", - "numeric": true + "numeric": false } ``` @@ -3899,7 +3942,7 @@ Availability of a SKU at a single inventory source. ```json { "available_qty": 123.45, - "is_in_stock": true, + "is_in_stock": false, "is_pickup_location_active": true, "name": "xyz789", "sku": "abc123", @@ -3926,8 +3969,8 @@ For retrieving statistics across multiple buckets ```json { "max": 123.45, - "min": 987.65, - "title": "abc123" + "min": 123.45, + "title": "xyz789" } ``` @@ -4050,6 +4093,10 @@ Contains information about a store's configuration. | `quote_minimum_amount` - [`Float`](/reference/graphql/saas/types-f-i.md#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_public_share_link_validity_days` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from btob/requisition_list_public_sharing/link_validity_days | +| `requisition_list_public_share_max_recipients` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from btob/requisition_list_public_sharing/max_recipients | +| `requisition_list_public_share_storefront_path` - [`String!`](#string) | Configuration data from btob/requisition_list_public_sharing/storefront_share_path (route path for public share links, no leading or trailing slashes) | +| `requisition_list_public_sharing_enabled` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Configuration data from btob/requisition_list_public_sharing/enabled | | `requisition_list_share_link_validity_days` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | Configuration data from btob/requisition_list_sharing/link_validity_days | | `requisition_list_share_max_recipients` - [`Int!`](/reference/graphql/saas/types-f-i.md#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) | @@ -4099,136 +4146,140 @@ Contains information about a store's configuration. ```json { - "allow_company_registration": true, - "allow_gift_receipt": "xyz789", + "allow_company_registration": false, + "allow_gift_receipt": "abc123", "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", + "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", "allow_items": "abc123", "allow_order": "abc123", - "allow_printed_card": "xyz789", - "autocomplete_on_storefront": true, - "base_currency_code": "xyz789", - "base_link_url": "xyz789", - "base_media_url": "abc123", - "base_static_url": "abc123", - "base_url": "xyz789", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": false, + "base_currency_code": "abc123", + "base_link_url": "abc123", + "base_media_url": "xyz789", + "base_static_url": "xyz789", + "base_url": "abc123", "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "abc123", - "cart_printed_card": "abc123", - "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "xyz789", + "cart_merge_preference": "xyz789", + "cart_printed_card": "xyz789", + "cart_summary_display_quantity": 123, + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "category_url_suffix": "abc123", - "check_money_order_enable_for_specific_countries": true, - "check_money_order_enabled": true, - "check_money_order_make_check_payable_to": "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_enable_for_specific_countries": false, + "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_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": true, - "countries_with_required_region": "xyz789", + "countries_with_required_region": "abc123", "create_account_confirmation": false, - "customer_access_token_lifetime": 987.65, + "customer_access_token_lifetime": 123.45, "default_country": "abc123", - "default_display_currency_code": "abc123", + "default_display_currency_code": "xyz789", "display_product_prices_in_catalog": 987, "display_shipping_prices": 123, "display_state_if_optional": false, "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": 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": 123, "fixed_product_taxes_display_prices_in_sales_modules": 987, "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": true, + "fixed_product_taxes_include_fpt_in_subtotal": true, + "graphql_share_customer_group": false, "grid_per_page": 123, - "grid_per_page_values": "xyz789", + "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": false, - "is_default_store": false, - "is_default_store_group": true, - "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, + "is_checkout_agreements_enabled": true, + "is_default_store": true, + "is_default_store_group": false, + "is_guest_checkout_enabled": true, + "is_negotiable_quote_active": true, "is_one_page_checkout_enabled": false, "is_requisition_list_active": "xyz789", "list_mode": "xyz789", - "list_per_page": 123, - "list_per_page_values": "xyz789", - "locale": "abc123", + "list_per_page": 987, + "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_on_front": "xyz789", "magento_reward_general_min_points_balance": "xyz789", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "abc123", + "magento_reward_points_invitation_customer": "xyz789", "magento_reward_points_invitation_customer_limit": "abc123", "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "abc123", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "abc123", - "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "abc123", + "magento_reward_points_review": "xyz789", + "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_display": true, "minicart_max_items": 123, - "minimum_password_length": "abc123", + "minimum_password_length": "xyz789", "newsletter_enabled": true, "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_price": 123, - "orders_invoices_credit_memos_display_shipping_amount": 987, - "orders_invoices_credit_memos_display_subtotal": 123, - "orders_invoices_credit_memos_display_zero_tax": false, - "persistent_enabled": false, + "orders_invoices_credit_memos_display_price": 987, + "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_subtotal": 987, + "orders_invoices_credit_memos_display_zero_tax": true, + "persistent_enabled": true, "persistent_options_wishlist": true, "persistent_shopping_cart": true, "printed_card_priceV2": Money, - "product_alert_allow_stock": true, + "product_alert_allow_stock": false, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", "product_url_suffix": "xyz789", - "quickorder_active": false, - "quote_minimum_amount": 123.45, - "quote_minimum_amount_message": "xyz789", + "quickorder_active": true, + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "abc123", "required_character_classes_number": "abc123", - "requisition_list_share_link_validity_days": 987, + "requisition_list_public_share_link_validity_days": 987, + "requisition_list_public_share_max_recipients": 987, + "requisition_list_public_share_storefront_path": "abc123", + "requisition_list_public_sharing_enabled": true, + "requisition_list_share_link_validity_days": 123, "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "xyz789", - "requisition_list_sharing_enabled": true, - "returns_enabled": "xyz789", + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": false, + "returns_enabled": "abc123", "root_category_uid": 4, "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", - "sales_printed_card": "abc123", + "sales_printed_card": "xyz789", "secure_base_link_url": "xyz789", - "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", + "secure_base_media_url": "abc123", + "secure_base_static_url": "abc123", + "secure_base_url": "xyz789", "share_active_segments": false, - "share_applied_cart_rule": false, - "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "xyz789", - "shopping_assistance_checkbox_tooltip": "xyz789", + "share_applied_cart_rule": true, + "share_customer_accounts_scope": 987, + "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_tooltip": "abc123", "shopping_assistance_enabled": true, - "shopping_cart_display_full_summary": true, - "shopping_cart_display_grand_total": false, + "shopping_cart_display_full_summary": false, + "shopping_cart_display_grand_total": true, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, "shopping_cart_display_subtotal": 123, @@ -4236,18 +4287,18 @@ Contains information about a store's configuration. "shopping_cart_display_zero_tax": true, "store_code": "4", "store_group_code": 4, - "store_group_name": "xyz789", - "store_name": "xyz789", - "store_sort_order": 123, + "store_group_name": "abc123", + "store_name": "abc123", + "store_sort_order": 987, "timezone": "xyz789", - "title_separator": "abc123", - "use_store_in_url": false, - "website_code": "4", - "website_name": "abc123", - "weight_unit": "abc123", - "zero_subtotal_enable_for_specific_countries": true, + "title_separator": "xyz789", + "use_store_in_url": true, + "website_code": 4, + "website_name": "xyz789", + "weight_unit": "xyz789", + "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "abc123", + "zero_subtotal_new_order_status": "xyz789", "zero_subtotal_payment_action": "xyz789", "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 987, @@ -4264,7 +4315,7 @@ The `String` scalar type represents textual data, represented as UTF-8 character #### Example ```json -"abc123" +"xyz789" ``` @@ -4326,12 +4377,12 @@ Specifies the quote template properties to update. "attachments": [NegotiableQuoteCommentAttachmentInput], "comment": "abc123", "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "xyz789", + "min_order_commitment": 123, + "name": "abc123", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], - "template_id": "4" + "template_id": 4 } ``` @@ -4390,7 +4441,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"depth": 987, "startLevel": 123} +{"depth": 123, "startLevel": 987} ``` @@ -4414,7 +4465,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"value": "xyz789"} +{"value": "abc123"} ``` @@ -4491,7 +4542,7 @@ Synchronizes the payment order details ```json { "cartId": "xyz789", - "id": "abc123" + "id": "xyz789" } ``` diff --git a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md index a5940f4ad..ae71e5034 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-types-t-z.md @@ -18,7 +18,7 @@ Contains tax item details. { "amount": Money, "rate": 987.65, - "title": "xyz789" + "title": "abc123" } ``` @@ -159,10 +159,10 @@ Contains the response to the request to unassign a child company. { "unitName": "abc123", "storefrontLabel": "xyz789", - "pagePlacement": "abc123", + "pagePlacement": "xyz789", "displayNumber": 987, "pageType": "abc123", - "unitStatus": "xyz789", + "unitStatus": "abc123", "typeId": "abc123", "filterRules": [FilterRuleInput] } @@ -186,7 +186,7 @@ Provide either rec unit ids or labels to retrieve rec units ```json { "unitIds": ["xyz789"], - "labels": ["xyz789"] + "labels": ["abc123"] } ``` @@ -207,7 +207,7 @@ Modifies the specified items in the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_items": [CartItemUpdateInput] } ``` @@ -250,7 +250,7 @@ Defines the input schema for updating company configuration. #### Example ```json -{"address_book_enabled": false, "custom_shipping_address_enabled": true} +{"address_book_enabled": true, "custom_shipping_address_enabled": false} ``` @@ -411,8 +411,8 @@ Defines updates to an item in a gift registry. ```json { - "gift_registry_item_uid": 4, - "note": "abc123", + "gift_registry_item_uid": "4", + "note": "xyz789", "quantity": 987.65 } ``` @@ -477,9 +477,9 @@ Defines updates to an existing registrant. GiftRegistryDynamicAttributeInput ], "email": "xyz789", - "firstname": "abc123", - "gift_registry_registrant_uid": "4", - "lastname": "abc123" + "firstname": "xyz789", + "gift_registry_registrant_uid": 4, + "lastname": "xyz789" } ``` @@ -628,10 +628,10 @@ Defines the changes to be made to an approval rule. "applies_to": ["4"], "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, - "description": "xyz789", - "name": "xyz789", + "description": "abc123", + "name": "abc123", "status": "ENABLED", - "uid": "4" + "uid": 4 } ``` @@ -646,6 +646,7 @@ An input object that defines which requistion list characteristics to update. | Input Field | Description | |-------------|-------------| | `description` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The updated description of the requisition list. | +| `is_public` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the requisition list is publicly shareable. Optional; pass true to make the list public or false to make it private again. When omitted, the current value is left unchanged. | | `name` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The new name of the requisition list. | #### Example @@ -653,7 +654,8 @@ An input object that defines which requistion list characteristics to update. ```json { "description": "xyz789", - "name": "abc123" + "is_public": true, + "name": "xyz789" } ``` @@ -738,7 +740,7 @@ Contains the name and visibility of an updated wish list. ```json { "name": "xyz789", - "uid": 4, + "uid": "4", "visibility": "PUBLIC" } ``` @@ -843,7 +845,7 @@ Defines the purchase orders to be validated. #### Example ```json -{"purchase_order_uids": [4]} +{"purchase_order_uids": ["4"]} ``` @@ -886,7 +888,7 @@ Defines a customer attribute validation rule. ```json { "name": "DATE_RANGE_MAX", - "value": "xyz789" + "value": "abc123" } ``` @@ -975,9 +977,9 @@ Vault payment inputs ```json { - "payment_source": "xyz789", - "payments_order_id": "xyz789", - "paypal_order_id": "xyz789", + "payment_source": "abc123", + "payments_order_id": "abc123", + "paypal_order_id": "abc123", "public_hash": "xyz789" } ``` @@ -1018,7 +1020,7 @@ User view history ```json { "date": "2007-12-03T10:15:30Z", - "sku": "abc123" + "sku": "xyz789" } ``` @@ -1085,8 +1087,8 @@ An implementation for virtual product cart items. "errors": [CartItemError], "is_available": true, "is_free_gift": false, - "is_salable": true, - "max_qty": 987.65, + "is_salable": false, + "max_qty": 123.45, "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], @@ -1158,9 +1160,9 @@ Defines a virtual product, which is a non-tangible product that does not require ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, @@ -1168,24 +1170,24 @@ Defines a virtual product, which is a non-tangible product that does not require "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", + "is_returnable": "xyz789", "manufacturer": 123, - "max_sale_qty": 987.65, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", - "meta_keyword": "abc123", + "meta_description": "abc123", + "meta_keyword": "xyz789", "meta_title": "xyz789", - "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": [CustomizableOptionInterface], "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, + "quantity": 123.45, "rating_summary": 123.45, "related_products": [ProductInterface], "review_count": 987, @@ -1193,14 +1195,14 @@ Defines a virtual product, which is a non-tangible product that does not require "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -1228,7 +1230,7 @@ Contains details about virtual products added to a requisition list. "product": ProductInterface, "quantity": 123.45, "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -1280,7 +1282,7 @@ An error encountered while performing operations with WishList. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789" + "message": "abc123" } ``` @@ -1325,11 +1327,11 @@ Contains a customer wish list. ```json { - "id": 4, + "id": "4", "items_count": 987, "items_v2": WishlistItems, "name": "abc123", - "sharing_code": "xyz789", + "sharing_code": "abc123", "updated_at": "abc123", "visibility": "PUBLIC" } @@ -1356,7 +1358,7 @@ Contains details about errors encountered when a customer added wish list items { "code": "PRODUCT_NOT_FOUND", "message": "xyz789", - "wishlistId": 4, + "wishlistId": "4", "wishlistItemId": 4 } ``` @@ -1426,9 +1428,9 @@ Defines the items to add to a wish list. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "abc123", + "parent_sku": "xyz789", "quantity": 123.45, - "selected_options": ["4"], + "selected_options": [4], "sku": "xyz789" } ``` @@ -1471,7 +1473,7 @@ The interface for wish list items. "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1514,11 +1516,11 @@ Defines updates to items in a wish list. ```json { - "description": "abc123", + "description": "xyz789", "entered_options": [EnteredOptionInput], "quantity": 123.45, - "selected_options": ["4"], - "wishlist_item_id": "4" + "selected_options": [4], + "wishlist_item_id": 4 } ```