From b3d51c6808bd4c946ebcf66e3a3aa82a666155c4 Mon Sep 17 00:00:00 2001 From: Jared Hoover Date: Thu, 22 Oct 2026 12:08:03 -0500 Subject: [PATCH] update schemas - ACCS --- spectaql/schema_saas.json | 553 ++++++++++- src/openapi/accs-schema.yaml | 363 +++++++ .../graphql-api-saas-mutations.md | 477 +++++----- .../autogenerated/graphql-api-saas-queries.md | 714 +++++++------- .../graphql-api-saas-types-a-b.md | 262 +++--- .../graphql-api-saas-types-c-e.md | 890 ++++++++++-------- .../graphql-api-saas-types-f-i.md | 363 ++++--- .../graphql-api-saas-types-k-p.md | 534 ++++++----- .../graphql-api-saas-types-q-s.md | 518 +++++----- .../graphql-api-saas-types-t-z.md | 110 +-- 10 files changed, 2931 insertions(+), 1853 deletions(-) diff --git a/spectaql/schema_saas.json b/spectaql/schema_saas.json index e83482a48..bd4fbe727 100644 --- a/spectaql/schema_saas.json +++ b/spectaql/schema_saas.json @@ -9416,13 +9416,9 @@ "name": "telephone", "description": "The telephone number for the billing or shipping address.", "type": { - "kind": "NON_NULL", - "name": null, - "ofType": { - "kind": "SCALAR", - "name": "String", - "ofType": null - } + "kind": "SCALAR", + "name": "String", + "ofType": null }, "defaultValue": null }, @@ -11401,6 +11397,45 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "CatalogViewContext", + "description": "", + "fields": [ + { + "name": "accessToken", + "description": "RS256-signed access token (exp-only) authorizing the catalog view scope. Null when issuance is disabled or no active signing key is available.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "catalogViewId", + "description": "ACO Catalog View id for the company's entitled catalog view.", + "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": "CategoryBucket", @@ -14042,6 +14077,18 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "catalogViewContext", + "description": "ACO catalog-view runtime context (view id + signed access token) for this company. Null when the company has no entitled catalog view or the caller is not an authenticated company customer.", + "args": [], + "type": { + "kind": "OBJECT", + "name": "CatalogViewContext", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "company_admin", "description": "An object containing information about the company administrator.", @@ -18014,6 +18061,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "gallery", + "description": "A list of all images and videos defined for the product, ordered as a single media gallery.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "ProductViewMedia", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "lastModifiedAt", "description": "Date and time when the product was last updated.", @@ -25807,6 +25870,33 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "chain_totals", + "description": "Aggregated sales totals across every order in the order-edit chain identified by the `original_number` filter. Requires the `original_number.eq` filter; the `in` condition is not supported here. Returns null if the chain doesn't exist, is empty, or doesn't belong to the current customer.", + "args": [ + { + "name": "filter", + "description": null, + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "CustomerChainTotalsFilterInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "OBJECT", + "name": "OrderChainTotal", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "companies", "description": "An object that contains a list of companies user is assigned to.", @@ -27618,6 +27708,31 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "INPUT_OBJECT", + "name": "CustomerChainTotalsFilterInput", + "description": "Filter input for customer chain totals.", + "fields": null, + "inputFields": [ + { + "name": "original_number", + "description": "Filter by any order number in an order-edit chain (the original order or one of its edited children) to return the full chain totals.", + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + } + }, + "defaultValue": null + } + ], + "interfaces": null, + "enumValues": null, + "possibleTypes": null + }, { "kind": "INPUT_OBJECT", "name": "CustomerCreateInput", @@ -27804,6 +27919,42 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "file_extension", + "description": "The extension of the downloadable file, in lower case and without the leading dot. Null if unknown.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "file_name", + "description": "The name of the downloadable file, including its extension. Null if unknown.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "mime_type", + "description": "The MIME type of the downloadable file, such as `audio/mpeg` or `application/pdf`. Null if unknown.", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "order_increment_id", "description": "The unique ID assigned to the item.", @@ -28636,6 +28787,16 @@ }, "defaultValue": null }, + { + "name": "original_number", + "description": "Filter by any order number in an order-edit chain (the original order or one of its edited children) to return the full chain.", + "type": { + "kind": "INPUT_OBJECT", + "name": "FilterEqualTypeInput", + "ofType": null + }, + "defaultValue": null + }, { "name": "search", "description": "Searches orders by order number, product name, or SKU.", @@ -41431,6 +41592,16 @@ "description": "", "fields": null, "inputFields": [ + { + "name": "checksum_sha256", + "description": "Optional base64-encoded SHA-256 digest of the file, computed by the client before calling this mutation; when set, Amazon S3 rejects the upload if the received bytes don't match it", + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "defaultValue": null + }, { "name": "key", "description": "The name of the file to be uploaded, cannot contain slashes", @@ -53903,6 +54074,161 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "OrderChainTotal", + "description": "Aggregated sales totals across every order in an order-edit chain.", + "fields": [ + { + "name": "grand_total", + "description": "The sum of grand total across every order in the chain, net of canceled amounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "order_count", + "description": "The number of orders included in the chain aggregation.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "subtotal", + "description": "The sum of subtotal across every order in the chain, net of canceled subtotal amounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_canceled", + "description": "The sum of the amount canceled across every order in the chain.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_discounted", + "description": "The total discount amount across every order in the chain, net of canceled discount amounts (non-negative).", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_invoiced", + "description": "The sum of the amount invoiced across every order in the chain.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_refunded", + "description": "The sum of the amount refunded across every order in the chain.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_shipping", + "description": "The sum of shipping amount across every order in the chain, net of canceled shipping amounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "total_tax", + "description": "The sum of tax amount across every order in the chain, net of canceled tax amounts.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "Money", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [], + "enumValues": null, + "possibleTypes": null + }, { "kind": "OBJECT", "name": "OrderCustomerInfo", @@ -59758,6 +60084,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "gallery", + "description": "A list of all images and videos defined for the product, ordered as a single media gallery.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "ProductViewMedia", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "lastModifiedAt", "description": "Date and time when the product was last updated.", @@ -61422,6 +61764,27 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "UNION", + "name": "ProductViewMedia", + "description": "A single entry in the product media gallery. The entry can be either an image or a video.", + "fields": null, + "inputFields": null, + "interfaces": null, + "enumValues": null, + "possibleTypes": [ + { + "kind": "OBJECT", + "name": "ProductViewImage", + "ofType": null + }, + { + "kind": "OBJECT", + "name": "ProductViewVideo", + "ofType": null + } + ] + }, { "kind": "OBJECT", "name": "ProductViewMoney", @@ -65688,11 +66051,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. Only SKUs of products the shopper may see in the current website's catalog are reported.", + "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. Per-source availability is a physical snapshot, not a purchasable-quantity limit: use stockAvailability for the salable quantity and the Add to Cart gate. Returns an empty list when per-source disclosure is not enabled for the store (cataloginventory/source_availability/storefront_enabled off).", "args": [ { "name": "skus", - "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.", + "description": "The product SKUs to report availability for, at most 100. 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, @@ -65757,6 +66120,49 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "stockAvailability", + "description": "Stock-level salable quantity and purchase eligibility for one or more SKUs, evaluated against the current sales channel's stock. Read directly from the inventory and reservation tables, so it is strongly consistent with what the cart enforces at add-to-cart and order placement, and accounts for every open reservation — including orders placed without a nominated source, which per-source availability cannot attribute to any one source. Can be combined with sourceAvailability in a single request. 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, at most 100. 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, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "String", + "ofType": null + } + } + } + }, + "defaultValue": null + } + ], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "OBJECT", + "name": "StockAvailability", + "ofType": null + } + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "storeConfig", "description": "Return details about the store's configuration.", @@ -75495,6 +75901,22 @@ "isDeprecated": false, "deprecationReason": null }, + { + "name": "gallery", + "description": "A list of all images and videos defined for the product, ordered as a single media gallery.", + "args": [], + "type": { + "kind": "LIST", + "name": null, + "ofType": { + "kind": "UNION", + "name": "ProductViewMedia", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, { "name": "inputOptions", "description": "A list of input options. For example, a text field, a number field or a date field.", @@ -75980,34 +76402,6 @@ "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.", @@ -76026,7 +76420,7 @@ }, { "name": "sources", - "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.", + "description": "Availability at each reported source.", "args": [], "type": { "kind": "NON_NULL", @@ -76931,6 +77325,89 @@ "enumValues": null, "possibleTypes": null }, + { + "kind": "OBJECT", + "name": "StockAvailability", + "description": "Stock-level availability of a single SKU in the current sales channel's stock.", + "fields": [ + { + "name": "backorder_message", + "description": "Customer-facing pre-order notice, populated only when the SKU is salable solely because notify-mode backorders are enabled — it is salable but not in stock; null otherwise (in stock, silent backorders, or not salable).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "String", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_in_stock", + "description": "Whether the smallest valid purchase (the minimum sale quantity, rounded up to the quantity increment; one unit by default) can be fulfilled from stock on hand, excluding any backorder allowance. False for a SKU that is purchasable only through backorders. For a SKU whose stock is not tracked, or a composite parent, equal to is_salable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "is_salable", + "description": "Whether the SKU can be added to the cart right now in its smallest valid purchase quantity (the minimum sale quantity, rounded up to the quantity increment; one unit by default), backorders considered. This is the authoritative Add to Cart gate. Respects the merchant's stock status override, and for a composite parent (configurable, bundle, grouped) the parent's own stock status: a parent set Out of Stock is not salable even when its children are in stock. True for a SKU whose stock is not tracked (Manage Stock disabled), except that on a custom stock a SKU must be assigned to one of the stock's sources to be salable.", + "args": [], + "type": { + "kind": "NON_NULL", + "name": null, + "ofType": { + "kind": "SCALAR", + "name": "Boolean", + "ofType": null + } + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "salable_qty", + "description": "Quantity that can be purchased right now: physical quantity across the stock's sources, net of every open reservation and the out-of-stock threshold; the figure the cart enforces. With a negative out-of-stock threshold (backorders allowed down to a limit) it includes that backorder allowance, so it can exceed the physical stock; do not use it as an on-hand count, such as an only-X-left badge. is_in_stock tells whether a purchase can ship from stock on hand. The exact value is returned only when it is at or below the merchant's storefront display threshold (cataloginventory/options/stock_threshold_qty). Null above that threshold, when the SKU's stock is not tracked, or for a composite parent (configurable, bundle, grouped).", + "args": [], + "type": { + "kind": "SCALAR", + "name": "Float", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "sku", + "description": "The product SKU the availability applies to.", + "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": "StoreConfig", diff --git a/src/openapi/accs-schema.yaml b/src/openapi/accs-schema.yaml index 22aac7039..743761cf8 100644 --- a/src/openapi/accs-schema.yaml +++ b/src/openapi/accs-schema.yaml @@ -2854,6 +2854,10 @@ definitions: company-data-company-extension-interface: description: ExtensionInterface class for @see \Magento\Company\Api\Data\CompanyInterface properties: + aco_catalog_view_ids: + items: + type: string + type: array applicable_payment_method: type: integer applicable_shipping_method: @@ -3884,6 +3888,93 @@ definitions: - code - name type: object + directory-region-rest-api-data-region-create-request-interface: + description: 'Writable fields accepted when creating a region. Deliberately excludes + region_id, country_id, and system: region_id is assigned by the database, country_id + comes from the countryId URL segment, and system is always server-computed. + Magento''s webapi framework resolves setters strictly against this interface, + so sending any of those three fields in a request body is rejected with a 400 + InputException ("... is not supported") rather than being accepted and applied.' + properties: + code: + description: Region code, e.g. "CA". + type: string + default_name: + description: Default (fallback) region name. + type: string + locale_names: + description: Locale-specific name overrides. + items: + "$ref": "#/definitions/directory-region-rest-api-data-region-locale-name-interface" + type: array + required: + - code + - default_name + type: object + directory-region-rest-api-data-region-data-interface: + description: Represents a country region backed by core's directory_country_region + table. + properties: + code: + description: Region code, e.g. "CA". + type: string + country_id: + description: Two-letter (ISO 3166-1 alpha-2) country id, e.g. "US". + type: string + default_name: + description: Default (fallback) region name. + type: string + locale_names: + description: Locale-specific name overrides. Always populated as an array + (including empty) in responses. + items: + "$ref": "#/definitions/directory-region-rest-api-data-region-locale-name-interface" + type: array + region_id: + description: Region id. Null for a region not yet persisted. + type: integer + system: + description: This region is a Magento system-seeded region (true) or was created + by a tenant via this API (false). + type: boolean + required: + - locale_names + - country_id + - system + - code + - default_name + type: object + directory-region-rest-api-data-region-locale-name-interface: + description: Represents a single locale-specific display name for a country region. + properties: + locale: + description: Locale code, e.g. "en_US". + type: string + name: + description: The localized region name. + type: string + required: + - locale + - name + type: object + directory-region-rest-api-data-region-search-result-interface: + description: Search results interface for country region list operations. + properties: + items: + description: The list of regions. + items: + "$ref": "#/definitions/directory-region-rest-api-data-region-data-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 downloadable-data-downloadable-option-interface: description: Downloadable Option properties: @@ -19416,6 +19507,219 @@ paths: tags: - directory/countries/{countryId} summary: directory/countries/{countryId} + "/V1/directory/countries/{countryId}/regions": + get: + consumes: + - application/json + - application/xml + description: Retrieve regions belonging to the given country, matching search + criteria. $searchCriteria is optional; when omitted, all regions for the country + are returned unfiltered. + operationId: GetV1DirectoryCountriesCountryIdRegions + parameters: + - description: two-letter (ISO 3166-1 alpha-2) country id, e.g. "US" + in: path + name: countryId + required: true + type: string + - 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/directory-region-rest-api-data-region-search-result-interface" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - directory/countries/{countryId}/regions + summary: directory/countries/{countryId}/regions + post: + consumes: + - application/json + - application/xml + description: 'Create one or more regions under the given country in a single + atomic operation. All-or-nothing: the whole payload is validated before anything + is written, and every region is persisted in one transaction, so a failure + anywhere leaves no rows behind. Validation failures are reported together + in one InputException, each naming the offending payload position (e.g. `regions[3].code`). + Region codes must be unique within the country *and* within the payload. The + number of regions accepted per call is capped.' + operationId: PostV1DirectoryCountriesCountryIdRegions + parameters: + - description: two-letter (ISO 3166-1 alpha-2) country id, e.g. "US" + in: path + name: countryId + required: true + type: string + - in: body + name: PostV1DirectoryCountriesCountryIdRegionsBody + schema: + properties: + regions: + items: + "$ref": "#/definitions/directory-region-rest-api-data-region-create-request-interface" + type: array + required: + - regions + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + description: in payload order + items: + "$ref": "#/definitions/directory-region-rest-api-data-region-data-interface" + type: array + '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: + - directory/countries/{countryId}/regions + summary: directory/countries/{countryId}/regions + "/V1/directory/countries/{countryId}/regions/{regionId}": + delete: + consumes: + - application/json + - application/xml + description: Delete a region belonging to the given country. Cascades to its + locale names. + operationId: DeleteV1DirectoryCountriesCountryIdRegionsRegionId + parameters: + - description: two-letter (ISO 3166-1 alpha-2) country id, e.g. "US" + in: path + name: countryId + required: true + type: string + - in: path + name: regionId + 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: + - directory/countries/{countryId}/regions/{regionId} + summary: directory/countries/{countryId}/regions/{regionId} + put: + consumes: + - application/json + - application/xml + description: 'Update an existing region belonging to the given country. Locale + names use replace semantics: the provided array fully replaces the existing + set of locale-name rows for the region. A region cannot be moved to a different + country through this operation.' + operationId: PutV1DirectoryCountriesCountryIdRegionsRegionId + parameters: + - description: two-letter (ISO 3166-1 alpha-2) country id, e.g. "US" + in: path + name: countryId + required: true + type: string + - in: path + name: regionId + required: true + type: integer + - in: body + name: PutV1DirectoryCountriesCountryIdRegionsRegionIdBody + schema: + properties: + region: + "$ref": "#/definitions/directory-region-rest-api-data-region-create-request-interface" + required: + - region + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/directory-region-rest-api-data-region-data-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: + - directory/countries/{countryId}/regions/{regionId} + summary: directory/countries/{countryId}/regions/{regionId} "/V1/eav/attribute-sets": post: consumes: @@ -22667,6 +22971,59 @@ paths: tags: - media/initiate-upload summary: media/initiate-upload + "/V1/media/initiate-upload-with-checksum": + post: + consumes: + - application/json + - application/xml + description: Generate a presigned S3 URL for direct upload, with a client-supplied + integrity checksum. $checksumSha256 must be the base64-encoded SHA-256 digest + the client computed from the file itself, *before* calling this method - we + never compute or invent a value on the client's behalf, since we don't have + the file. That exact value is signed into the presigned URL; Amazon S3 rejects + the upload outright if the bytes it actually receives don't match it. + operationId: PostV1MediaInitiateuploadwithchecksum + parameters: + - in: body + name: PostV1MediaInitiateuploadwithchecksumBody + schema: + properties: + checksumSha256: + type: string + key: + type: string + mediaResourceType: + type: string + required: + - key + - mediaResourceType + - checksumSha256 + type: object + xml: + name: request + produces: + - application/json + - application/xml + responses: + '200': + description: 200 Success. + schema: + "$ref": "#/definitions/s3-presigned-upload-data-initiate-upload-response-interface" + '400': + description: 400 Bad Request + schema: + "$ref": "#/definitions/error-response" + '401': + description: 401 Unauthorized + schema: + "$ref": "#/definitions/error-response" + default: + description: Unexpected error + schema: + "$ref": "#/definitions/error-response" + tags: + - media/initiate-upload-with-checksum + summary: media/initiate-upload-with-checksum "/V1/modules": get: consumes: @@ -32801,6 +33158,8 @@ tags: - name: customerSegments/search - name: directory/countries - name: directory/countries/{countryId} +- name: directory/countries/{countryId}/regions +- name: directory/countries/{countryId}/regions/{regionId} - name: eav/attribute-sets - name: eav/attribute-sets/{attributeSetId} - name: eav/attribute-sets/list @@ -32863,6 +33222,7 @@ tags: - name: invoices/comments - name: media/finish-upload - name: media/initiate-upload +- name: media/initiate-upload-with-checksum - name: modules - name: negotiable-cart-item-note - name: negotiable-cart-item-note/{noteId} @@ -33260,6 +33620,8 @@ x-tagGroups: tags: - directory/countries - directory/countries/{countryId} + - directory/countries/{countryId}/regions + - directory/countries/{countryId}/regions/{regionId} - name: eav tags: - eav/attribute-sets @@ -33342,6 +33704,7 @@ x-tagGroups: tags: - media/finish-upload - media/initiate-upload + - media/initiate-upload-with-checksum - name: modules tags: - modules diff --git a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md index 345d77ce9..bdf4fece5 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-mutations.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-mutations.md @@ -115,8 +115,8 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu "acceptNegotiableQuoteTemplate": { "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, @@ -135,9 +135,9 @@ mutation acceptNegotiableQuoteTemplate($input: AcceptNegotiableQuoteTemplateInpu NegotiableQuoteShippingAddress ], "status": "abc123", - "template_id": 4, + "template_id": "4", "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "xyz789" } } @@ -227,7 +227,7 @@ mutation addGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrants": [AddGiftRegistryRegistrantInput] } ``` @@ -350,9 +350,9 @@ mutation addProductsToCompareList($input: AddProductsToCompareListInput) { "data": { "addProductsToCompareList": { "attributes": [ComparableAttribute], - "item_count": 123, + "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -447,7 +447,7 @@ mutation addProductsToRequisitionList( ```json { - "requisitionListUid": "4", + "requisitionListUid": 4, "requisitionListItems": [RequisitionListItemsInput] } ``` @@ -505,10 +505,7 @@ mutation addProductsToWishlist( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItems": [WishlistItemInput] -} +{"wishlistId": 4, "wishlistItems": [WishlistItemInput]} ``` ##### Response @@ -712,10 +709,7 @@ mutation addRequisitionListItemsToCart( ##### Variables ```json -{ - "requisitionListUid": "4", - "requisitionListItemUids": [4] -} +{"requisitionListUid": 4, "requisitionListItemUids": [4]} ``` ##### Response @@ -866,10 +860,7 @@ mutation addWishlistItemsToCart( ##### Variables ```json -{ - "wishlistId": "4", - "wishlistItemIds": ["4"] -} +{"wishlistId": 4, "wishlistItemIds": [4]} ``` ##### Response @@ -1039,7 +1030,7 @@ mutation applyRewardPointsToCart($cartId: ID!) { ##### Variables ```json -{"cartId": 4} +{"cartId": "4"} ``` ##### Response @@ -1216,7 +1207,7 @@ mutation assignCompareListToCustomer($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response @@ -1339,16 +1330,16 @@ mutation assignCustomerToGuestCart($cart_id: String!) { "gift_message": GiftMessage, "gift_receipt_included": true, "gift_wrapping": GiftWrapping, - "has_available_free_gifts": false, + "has_available_free_gifts": true, "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": 987.65 + "total_quantity": 123.45 } } } @@ -1437,10 +1428,10 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "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": 123, + "max_order_commitment": 987, "min_order_commitment": 987, "name": "abc123", "notifications": [QuoteTemplateNotificationMessage], @@ -1452,11 +1443,11 @@ mutation cancelNegotiableQuoteTemplate($input: CancelNegotiableQuoteTemplateInpu "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, "total_quantity": 123.45, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -1506,7 +1497,7 @@ mutation cancelOrder($input: CancelOrderInput!) { { "data": { "cancelOrder": { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -1602,6 +1593,9 @@ mutation changeCustomerPassword( ...AdminAssistanceActionsFragment } allow_remote_shopping_assistance + chain_totals { + ...OrderChainTotalFragment + } companies { ...UserCompaniesOutputFragment } @@ -1717,36 +1711,37 @@ mutation changeCustomerPassword( "addresses": [CustomerAddress], "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, + "chain_totals": OrderChainTotal, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, "confirmation_status": "ACCOUNT_CONFIRMED", - "created_at": "abc123", + "created_at": "xyz789", "custom_attributes": [AttributeValueInterface], - "date_of_birth": "xyz789", - "default_billing": "xyz789", + "date_of_birth": "abc123", + "default_billing": "abc123", "default_shipping": "xyz789", - "email": "abc123", - "firstname": "abc123", + "email": "xyz789", + "firstname": "xyz789", "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": "4", + "id": 4, "is_subscribed": false, "job_title": "xyz789", - "lastname": "xyz789", + "lastname": "abc123", "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": false, - "quote_enabled": true, + "purchase_orders_enabled": true, + "quote_enabled": false, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -1756,11 +1751,11 @@ mutation changeCustomerPassword( "segments": [CustomerSegmentStorefront], "status": "ACTIVE", "store_credit": CustomerStoreCredit, - "structure_id": 4, + "structure_id": "4", "suffix": "xyz789", "taxvat": "xyz789", "team": CompanyTeam, - "telephone": "xyz789", + "telephone": "abc123", "wishlist_v2": Wishlist, "wishlists": [Wishlist] } @@ -1850,7 +1845,7 @@ mutation clearCustomerCart($cartUid: String!) { ##### Variables ```json -{"cartUid": "abc123"} +{"cartUid": "xyz789"} ``` ##### Response @@ -1858,7 +1853,7 @@ mutation clearCustomerCart($cartUid: String!) { ```json { "data": { - "clearCustomerCart": {"cart": Cart, "status": true} + "clearCustomerCart": {"cart": Cart, "status": false} } } ``` @@ -1897,7 +1892,7 @@ mutation clearWishlist($wishlistId: ID!) { ##### Variables ```json -{"wishlistId": 4} +{"wishlistId": "4"} ``` ##### Response @@ -2244,8 +2239,8 @@ mutation copyItemsBetweenRequisitionLists( ```json { - "sourceRequisitionListUid": 4, - "destinationRequisitionListUid": 4, + "sourceRequisitionListUid": "4", + "destinationRequisitionListUid": "4", "requisitionListItem": CopyItemsBetweenRequisitionListsInput } ``` @@ -2310,8 +2305,8 @@ mutation copyProductsBetweenWishlists( ```json { - "sourceWishlistUid": 4, - "destinationWishlistUid": "4", + "sourceWishlistUid": "4", + "destinationWishlistUid": 4, "wishlistItems": [WishlistItemCopyInput] } ``` @@ -2437,24 +2432,24 @@ mutation createCompanyAddress($input: CompanyAddressInput!) { "createCompanyAddress": { "address_type": "BILLING", "city": "xyz789", - "company": "abc123", - "company_id": 4, + "company": "xyz789", + "company_id": "4", "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "xyz789", "id": "4", - "is_default": false, + "is_default": true, "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "nickname": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "abc123", + "region_id": 987, + "street": ["xyz789"], + "suffix": "xyz789", "telephone": "abc123", "vat_id": "abc123" } @@ -2628,7 +2623,7 @@ mutation createCompareList($input: CreateCompareListInput) { "data": { "createCompareList": { "attributes": [ComparableAttribute], - "item_count": 987, + "item_count": 123, "items": [ComparableItem], "uid": 4 } @@ -2701,25 +2696,25 @@ mutation createCustomerAddress($input: CustomerAddressInput!) { "data": { "createCustomerAddress": { "city": "xyz789", - "company": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", + "fax": "xyz789", + "firstname": "xyz789", "id": 987, "lastname": "xyz789", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 987, + "region_id": 123, "street": ["abc123"], "suffix": "xyz789", - "telephone": "xyz789", - "uid": 4, + "telephone": "abc123", + "uid": "4", "vat_id": "xyz789" } } @@ -2889,8 +2884,8 @@ mutation createPaymentLink( ```json { - "cartId": "abc123", - "recipientEmail": "abc123" + "cartId": "xyz789", + "recipientEmail": "xyz789" } ``` @@ -2900,9 +2895,9 @@ mutation createPaymentLink( { "data": { "createPaymentLink": { - "expiresAt": "abc123", - "payUrl": "xyz789", - "token": "xyz789" + "expiresAt": "xyz789", + "payUrl": "abc123", + "token": "abc123" } } } @@ -2951,8 +2946,8 @@ mutation createPaymentOrder($input: CreatePaymentOrderInput!) { "data": { "createPaymentOrder": { "amount": 987.65, - "currency_code": "xyz789", - "id": "abc123", + "currency_code": "abc123", + "id": "xyz789", "mp_order_id": "xyz789", "status": "abc123" } @@ -3060,10 +3055,10 @@ mutation createPurchaseOrderApprovalRule($input: PurchaseOrderApprovalRuleInput! "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "abc123", + "created_at": "xyz789", "created_by": "abc123", - "description": "abc123", - "name": "abc123", + "description": "xyz789", + "name": "xyz789", "status": "ENABLED", "uid": 4, "updated_at": "abc123" @@ -3160,7 +3155,7 @@ mutation createVaultCardPaymentToken($input: CreateVaultCardPaymentTokenInput!) "data": { "createVaultCardPaymentToken": { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } } } @@ -3277,7 +3272,7 @@ mutation deleteCompanyAddress($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3315,13 +3310,13 @@ mutation deleteCompanyRole($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response ```json -{"data": {"deleteCompanyRole": {"success": false}}} +{"data": {"deleteCompanyRole": {"success": true}}} ``` @@ -3391,7 +3386,7 @@ mutation deleteCompanyUserV2($id: ID!) { ##### Variables ```json -{"id": 4} +{"id": "4"} ``` ##### Response @@ -3429,13 +3424,13 @@ mutation deleteCompareList($uid: ID!) { ##### Variables ```json -{"uid": 4} +{"uid": "4"} ``` ##### Response ```json -{"data": {"deleteCompareList": {"result": false}}} +{"data": {"deleteCompareList": {"result": true}}} ``` @@ -3535,7 +3530,7 @@ mutation deleteCustomerAddressV2($uid: ID!) { ##### Response ```json -{"data": {"deleteCustomerAddressV2": false}} +{"data": {"deleteCustomerAddressV2": true}} ``` @@ -3571,7 +3566,7 @@ mutation deleteNegotiableQuoteTemplate($input: DeleteNegotiableQuoteTemplateInpu ##### Response ```json -{"data": {"deleteNegotiableQuoteTemplate": true}} +{"data": {"deleteNegotiableQuoteTemplate": false}} ``` @@ -3665,7 +3660,7 @@ mutation deletePaymentToken($public_hash: String!) { ##### Variables ```json -{"public_hash": "xyz789"} +{"public_hash": "abc123"} ``` ##### Response @@ -3675,7 +3670,7 @@ mutation deletePaymentToken($public_hash: String!) { "data": { "deletePaymentToken": { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } } } @@ -3759,7 +3754,7 @@ mutation deleteRequisitionList($requisitionListUid: ID!) { ##### Variables ```json -{"requisitionListUid": 4} +{"requisitionListUid": "4"} ``` ##### Response @@ -3814,8 +3809,8 @@ mutation deleteRequisitionListItems( ```json { - "requisitionListUid": "4", - "requisitionListItemUids": [4] + "requisitionListUid": 4, + "requisitionListItemUids": ["4"] } ``` @@ -3982,11 +3977,11 @@ mutation estimateShippingMethods($input: EstimateTotalsInput!) { "additional_data": [ShippingAdditionalData], "amount": Money, "available": true, - "carrier_code": "xyz789", - "carrier_title": "xyz789", - "error_message": "abc123", - "method_code": "abc123", - "method_title": "xyz789", + "carrier_code": "abc123", + "carrier_title": "abc123", + "error_message": "xyz789", + "method_code": "xyz789", + "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money } @@ -4077,7 +4072,7 @@ mutation exchangeExternalCustomerToken($input: ExchangeExternalCustomerTokenInpu "data": { "exchangeExternalCustomerToken": { "customer": Customer, - "token": "xyz789" + "token": "abc123" } } } @@ -4120,8 +4115,8 @@ mutation exchangeOtpForCustomerToken( ```json { - "email": "abc123", - "otp": "abc123" + "email": "xyz789", + "otp": "xyz789" } ``` @@ -4176,8 +4171,8 @@ mutation finishUpload($input: finishUploadInput!) { "data": { "finishUpload": { "key": "abc123", - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -4220,7 +4215,7 @@ mutation generateCustomerToken( ```json { - "email": "abc123", + "email": "xyz789", "password": "abc123" } ``` @@ -4316,7 +4311,13 @@ mutation generateNegotiableQuoteFromTemplate($input: GenerateNegotiableQuoteFrom ##### Response ```json -{"data": {"generateNegotiableQuoteFromTemplate": {"negotiable_quote_uid": 4}}} +{ + "data": { + "generateNegotiableQuoteFromTemplate": { + "negotiable_quote_uid": "4" + } + } +} ``` @@ -4407,8 +4408,8 @@ mutation initiateUpload($input: initiateUploadInput!) { { "data": { "initiateUpload": { - "expires_at": "abc123", - "key": "abc123", + "expires_at": "xyz789", + "key": "xyz789", "upload_url": "abc123" } } @@ -4528,12 +4529,12 @@ mutation mergeCarts( ], "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, + "has_available_free_gifts": true, + "id": "4", "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, @@ -4652,7 +4653,7 @@ mutation moveItemsBetweenRequisitionLists( ```json { "sourceRequisitionListUid": "4", - "destinationRequisitionListUid": 4, + "destinationRequisitionListUid": "4", "requisitionListItem": MoveItemsBetweenRequisitionListsInput } ``` @@ -4764,7 +4765,7 @@ mutation moveProductsBetweenWishlists( ```json { - "sourceWishlistUid": "4", + "sourceWishlistUid": 4, "destinationWishlistUid": 4, "wishlistItems": [WishlistItemMoveInput] } @@ -4863,16 +4864,16 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "openNegotiableQuoteTemplate": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "created_at": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 123, + "max_order_commitment": 987, "min_order_commitment": 123, - "name": "abc123", + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -4882,8 +4883,8 @@ mutation openNegotiableQuoteTemplate($input: OpenNegotiableQuoteTemplateInput!) "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", - "template_id": "4", + "status": "xyz789", + "template_id": 4, "total_quantity": 123.45, "uid": 4, "updated_at": "abc123" @@ -5170,7 +5171,7 @@ mutation redeemGiftCardBalanceAsStoreCredit($input: GiftCardAccountInput!) { "redeemGiftCardBalanceAsStoreCredit": { "balance": Money, "code": "abc123", - "expiration_date": "abc123" + "expiration_date": "xyz789" } } } @@ -5381,7 +5382,7 @@ mutation removeGiftRegistry($giftRegistryUid: ID!) { ##### Response ```json -{"data": {"removeGiftRegistry": {"success": true}}} +{"data": {"removeGiftRegistry": {"success": false}}} ``` @@ -5479,7 +5480,7 @@ mutation removeGiftRegistryRegistrants( ```json { - "giftRegistryUid": 4, + "giftRegistryUid": "4", "registrantsUid": ["4"] } ``` @@ -5661,30 +5662,30 @@ mutation removeNegotiableQuoteTemplateItems($input: RemoveNegotiableQuoteTemplat "removeNegotiableQuoteTemplateItems": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "created_at": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], - "max_order_commitment": 987, + "max_order_commitment": 123, "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": "xyz789", - "template_id": 4, + "status": "abc123", + "template_id": "4", "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -5738,7 +5739,7 @@ mutation removeProductsFromCompareList($input: RemoveProductsFromCompareListInpu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -5785,7 +5786,7 @@ mutation removeProductsFromWishlist( ##### Variables ```json -{"wishlistId": 4, "wishlistItemsIds": [4]} +{"wishlistId": "4", "wishlistItemsIds": [4]} ``` ##### Response @@ -5999,7 +6000,7 @@ mutation reorderItems($orderNumber: String!) { ##### Variables ```json -{"orderNumber": "abc123"} +{"orderNumber": "xyz789"} ``` ##### Response @@ -6242,25 +6243,25 @@ mutation requestNegotiableQuoteTemplateFromQuote($input: RequestNegotiableQuoteT "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], "max_order_commitment": 123, "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", + "status": "xyz789", "template_id": 4, "total_quantity": 123.45, - "uid": 4, + "uid": "4", "updated_at": "abc123" } } @@ -6294,7 +6295,7 @@ mutation requestPasswordResetEmail($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -6386,7 +6387,7 @@ mutation resendConfirmationEmail($email: String!) { ##### Response ```json -{"data": {"resendConfirmationEmail": true}} +{"data": {"resendConfirmationEmail": false}} ``` @@ -6428,7 +6429,7 @@ mutation resetPassword( ```json { "email": "xyz789", - "resetPasswordToken": "xyz789", + "resetPasswordToken": "abc123", "newPassword": "abc123" } ``` @@ -6462,7 +6463,7 @@ mutation revokeCustomerToken { ##### Response ```json -{"data": {"revokeCustomerToken": {"result": false}}} +{"data": {"revokeCustomerToken": {"result": true}}} ``` @@ -6621,7 +6622,7 @@ mutation setCartAsInactive($cartId: String!) { ##### Variables ```json -{"cartId": "xyz789"} +{"cartId": "abc123"} ``` ##### Response @@ -7059,26 +7060,26 @@ mutation setDefaultCompanyAddress($id: ID!) { "data": { "setDefaultCompanyAddress": { "address_type": "BILLING", - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], - "fax": "xyz789", + "fax": "abc123", "firstname": "abc123", "id": "4", "is_default": false, "lastname": "abc123", - "middlename": "xyz789", - "nickname": "abc123", - "postcode": "abc123", + "middlename": "abc123", + "nickname": "xyz789", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, "region_id": 123, "street": ["abc123"], - "suffix": "abc123", - "telephone": "abc123", + "suffix": "xyz789", + "telephone": "xyz789", "vat_id": "abc123" } } @@ -7468,30 +7469,30 @@ mutation setNegotiableQuoteTemplateShippingAddress($input: SetNegotiableQuoteTem "setNegotiableQuoteTemplateShippingAddress": { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "xyz789", - "expiration_date": "abc123", + "created_at": "abc123", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, - "is_virtual": false, + "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "xyz789", + "max_order_commitment": 987, + "min_order_commitment": 123, + "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": 987.65, - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } } } @@ -7666,30 +7667,30 @@ mutation setQuoteTemplateExpirationDate($input: QuoteTemplateExpirationDateInput "setQuoteTemplateExpirationDate": { "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_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ NegotiableQuoteReferenceDocumentLink ], - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "abc123", + "status": "xyz789", "template_id": 4, - "total_quantity": 987.65, - "uid": "4", - "updated_at": "abc123" + "total_quantity": 123.45, + "uid": 4, + "updated_at": "xyz789" } } } @@ -7775,14 +7776,14 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], "created_at": "xyz789", - "expiration_date": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": true, "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 987, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -7794,10 +7795,10 @@ mutation setQuoteTemplateLineItemNote($input: QuoteTemplateLineItemNoteInput!) { NegotiableQuoteShippingAddress ], "status": "xyz789", - "template_id": "4", + "template_id": 4, "total_quantity": 987.65, "uid": 4, - "updated_at": "abc123" + "updated_at": "xyz789" } } } @@ -8069,7 +8070,7 @@ mutation shareRequisitionListByToken($requisitionListUid: ID!) { { "data": { "shareRequisitionListByToken": { - "token": "xyz789" + "token": "abc123" } } } @@ -8158,12 +8159,12 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, - "is_virtual": true, + "is_min_max_qty_used": true, + "is_virtual": false, "items": [CartItemInterface], "max_order_commitment": 123, - "min_order_commitment": 987, - "name": "abc123", + "min_order_commitment": 123, + "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, "reference_document_links": [ @@ -8173,11 +8174,11 @@ mutation submitNegotiableQuoteTemplateForReview($input: SubmitNegotiableQuoteTem "shipping_addresses": [ NegotiableQuoteShippingAddress ], - "status": "xyz789", - "template_id": "4", - "total_quantity": 987.65, + "status": "abc123", + "template_id": 4, + "total_quantity": 123.45, "uid": "4", - "updated_at": "xyz789" + "updated_at": "abc123" } } } @@ -8260,8 +8261,8 @@ mutation subscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "subscribeProductAlertPrice": { - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -8346,7 +8347,7 @@ mutation syncPaymentOrder($input: SyncPaymentOrderInput) { ##### Response ```json -{"data": {"syncPaymentOrder": false}} +{"data": {"syncPaymentOrder": true}} ``` @@ -8434,8 +8435,8 @@ mutation unsubscribeProductAlertPrice($input: ProductAlertPriceInput!) { { "data": { "unsubscribeProductAlertPrice": { - "message": "xyz789", - "success": true + "message": "abc123", + "success": false } } } @@ -8468,7 +8469,7 @@ mutation unsubscribeProductAlertPriceAll { { "data": { "unsubscribeProductAlertPriceAll": { - "message": "xyz789", + "message": "abc123", "success": false } } @@ -8515,7 +8516,7 @@ mutation unsubscribeProductAlertStock($input: ProductAlertStockInput!) { "data": { "unsubscribeProductAlertStock": { "message": "xyz789", - "success": true + "success": false } } } @@ -8548,8 +8549,8 @@ mutation unsubscribeProductAlertStockAll { { "data": { "unsubscribeProductAlertStockAll": { - "message": "abc123", - "success": true + "message": "xyz789", + "success": false } } } @@ -8708,7 +8709,10 @@ mutation updateCompanyAddress( ##### Variables ```json -{"id": 4, "input": CompanyAddressUpdateInput} +{ + "id": "4", + "input": CompanyAddressUpdateInput +} ``` ##### Response @@ -8718,27 +8722,27 @@ mutation updateCompanyAddress( "data": { "updateCompanyAddress": { "address_type": "BILLING", - "city": "xyz789", - "company": "xyz789", - "company_id": "4", + "city": "abc123", + "company": "abc123", + "company_id": 4, "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "abc123", - "id": "4", - "is_default": false, - "lastname": "xyz789", + "id": 4, + "is_default": true, + "lastname": "abc123", "middlename": "xyz789", "nickname": "abc123", "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["xyz789"], - "suffix": "abc123", - "telephone": "abc123", - "vat_id": "xyz789" + "region_id": 987, + "street": ["abc123"], + "suffix": "xyz789", + "telephone": "xyz789", + "vat_id": "abc123" } } } @@ -9019,27 +9023,27 @@ mutation updateCustomerAddress( { "data": { "updateCustomerAddress": { - "city": "xyz789", - "company": "xyz789", + "city": "abc123", + "company": "abc123", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "default_billing": true, - "default_shipping": true, + "default_billing": false, + "default_shipping": false, "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", - "firstname": "xyz789", + "firstname": "abc123", "id": 987, "lastname": "xyz789", "middlename": "xyz789", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", - "uid": "4", - "vat_id": "abc123" + "uid": 4, + "vat_id": "xyz789" } } } @@ -9107,10 +9111,7 @@ mutation updateCustomerAddressV2( ##### Variables ```json -{ - "uid": "4", - "input": CustomerAddressInput -} +{"uid": 4, "input": CustomerAddressInput} ``` ##### Response @@ -9119,26 +9120,26 @@ mutation updateCustomerAddressV2( { "data": { "updateCustomerAddressV2": { - "city": "xyz789", + "city": "abc123", "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], "default_billing": false, "default_shipping": true, "extension_attributes": [CustomerAddressAttribute], - "fax": "abc123", - "firstname": "abc123", - "id": 123, + "fax": "xyz789", + "firstname": "xyz789", + "id": 987, "lastname": "xyz789", "middlename": "abc123", - "postcode": "xyz789", + "postcode": "abc123", "prefix": "abc123", "region": CustomerAddressRegion, "region_id": 987, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", - "telephone": "xyz789", - "uid": 4, + "telephone": "abc123", + "uid": "4", "vat_id": "xyz789" } } @@ -9185,7 +9186,7 @@ mutation updateCustomerEmail( ```json { "email": "xyz789", - "password": "xyz789" + "password": "abc123" } ``` @@ -9609,13 +9610,13 @@ mutation updatePurchaseOrderApprovalRule($input: UpdatePurchaseOrderApprovalRule "applies_to_roles": [CompanyRole], "approver_roles": [CompanyRole], "condition": PurchaseOrderApprovalRuleConditionInterface, - "created_at": "xyz789", + "created_at": "abc123", "created_by": "abc123", - "description": "xyz789", - "name": "abc123", + "description": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "abc123" + "uid": "4", + "updated_at": "xyz789" } } } @@ -9716,7 +9717,7 @@ mutation updateRequisitionListItems( ```json { - "requisitionListUid": 4, + "requisitionListUid": "4", "requisitionListItems": [ UpdateRequisitionListItemsInput ] @@ -9777,8 +9778,8 @@ mutation updateWishlist( ```json { - "wishlistId": 4, - "name": "abc123", + "wishlistId": "4", + "name": "xyz789", "visibility": "PUBLIC" } ``` @@ -9790,7 +9791,7 @@ mutation updateWishlist( "data": { "updateWishlist": { "name": "xyz789", - "uid": 4, + "uid": "4", "visibility": "PUBLIC" } } diff --git a/src/pages/includes/autogenerated/graphql-api-saas-queries.md b/src/pages/includes/autogenerated/graphql-api-saas-queries.md index b48b42848..600636bbd 100644 --- a/src/pages/includes/autogenerated/graphql-api-saas-queries.md +++ b/src/pages/includes/autogenerated/graphql-api-saas-queries.md @@ -362,164 +362,164 @@ query availableStores($useCurrentGroup: Boolean) { "availableStores": [ { "allow_company_registration": true, - "allow_gift_receipt": "xyz789", - "allow_gift_wrapping_on_order": "xyz789", - "allow_gift_wrapping_on_order_items": "xyz789", + "allow_gift_receipt": "abc123", + "allow_gift_wrapping_on_order": "abc123", + "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "xyz789", - "allow_items": "abc123", + "allow_items": "xyz789", "allow_order": "abc123", - "allow_printed_card": "xyz789", + "allow_printed_card": "abc123", "autocomplete_on_storefront": false, - "base_currency_code": "xyz789", - "base_link_url": "abc123", + "base_currency_code": "abc123", + "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "xyz789", "base_url": "xyz789", - "cart_expires_in_days": 123, + "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", - "cart_merge_preference": "abc123", + "cart_merge_preference": "xyz789", "cart_printed_card": "abc123", "cart_summary_display_quantity": 123, - "catalog_default_sort_by": "xyz789", + "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": false, - "check_money_order_enabled": true, + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": false, "check_money_order_make_check_payable_to": "abc123", - "check_money_order_max_order_total": "abc123", + "check_money_order_max_order_total": "xyz789", "check_money_order_min_order_total": "xyz789", - "check_money_order_new_order_status": "xyz789", + "check_money_order_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "abc123", - "check_money_order_send_check_to": "xyz789", + "check_money_order_send_check_to": "abc123", "check_money_order_sort_order": 987, - "check_money_order_title": "abc123", - "company_credit_enabled": true, + "check_money_order_title": "xyz789", + "company_credit_enabled": false, "company_enabled": false, "configurable_product_image": "ITSELF", - "configurable_thumbnail_source": "xyz789", - "contact_enabled": false, + "configurable_thumbnail_source": "abc123", + "contact_enabled": true, "countries_with_required_region": "xyz789", - "create_account_confirmation": false, - "customer_access_token_lifetime": 987.65, + "create_account_confirmation": true, + "customer_access_token_lifetime": 123.45, "default_country": "xyz789", "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": false, - "enable_multiple_wishlists": "abc123", + "display_state_if_optional": true, + "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 987, - "fixed_product_taxes_display_prices_in_product_lists": 123, + "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_product_lists": 987, "fixed_product_taxes_display_prices_in_sales_modules": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 987, + "fixed_product_taxes_display_prices_on_product_view_page": 123, "fixed_product_taxes_enable": false, - "fixed_product_taxes_include_fpt_in_subtotal": false, + "fixed_product_taxes_include_fpt_in_subtotal": true, "graphql_share_customer_group": false, "grid_per_page": 123, "grid_per_page_values": "abc123", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": false, + "is_checkout_agreements_enabled": true, "is_default_store": false, "is_default_store_group": false, - "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": true, + "is_guest_checkout_enabled": false, + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": false, "is_requisition_list_active": "xyz789", "list_mode": "abc123", - "list_per_page": 987, + "list_per_page": 123, "list_per_page_values": "xyz789", "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", + "magento_reward_general_is_enabled": "xyz789", "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "xyz789", - "magento_reward_general_publish_history": "abc123", + "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": "abc123", - "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_customer_limit": "xyz789", + "magento_reward_points_invitation_order": "abc123", "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", + "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "xyz789", - "magento_reward_points_register": "xyz789", + "magento_reward_points_register": "abc123", "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": "xyz789", - "minicart_display": false, + "magento_reward_points_review_limit": "abc123", + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": true, "minicart_max_items": 987, - "minimum_password_length": "xyz789", - "newsletter_enabled": true, - "optional_zip_countries": "xyz789", + "minimum_password_length": "abc123", + "newsletter_enabled": false, + "optional_zip_countries": "abc123", "order_cancellation_enabled": true, "order_cancellation_reasons": [ CancellationReason ], - "orders_invoices_credit_memos_display_full_summary": true, + "orders_invoices_credit_memos_display_full_summary": false, "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": true, - "persistent_enabled": true, - "persistent_options_wishlist": false, - "persistent_shopping_cart": false, + "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, + "persistent_options_wishlist": true, + "persistent_shopping_cart": true, "printed_card_priceV2": Money, "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "abc123", "product_url_suffix": "abc123", "quickorder_active": true, - "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, + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "abc123", + "required_character_classes_number": "xyz789", + "requisition_list_public_share_link_validity_days": 987, + "requisition_list_public_share_max_recipients": 987, "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", + "requisition_list_public_sharing_enabled": true, + "requisition_list_share_link_validity_days": 123, + "requisition_list_share_max_recipients": 123, + "requisition_list_share_storefront_path": "xyz789", "requisition_list_sharing_enabled": true, "returns_enabled": "xyz789", "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "sales_gift_wrapping": "xyz789", "sales_printed_card": "xyz789", - "secure_base_link_url": "xyz789", + "secure_base_link_url": "abc123", "secure_base_media_url": "xyz789", - "secure_base_static_url": "xyz789", + "secure_base_static_url": "abc123", "secure_base_url": "xyz789", - "share_active_segments": false, + "share_active_segments": true, "share_applied_cart_rule": true, "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "abc123", - "shopping_assistance_enabled": true, - "shopping_cart_display_full_summary": true, + "shopping_assistance_enabled": false, + "shopping_cart_display_full_summary": false, "shopping_cart_display_grand_total": true, - "shopping_cart_display_price": 987, - "shopping_cart_display_shipping": 987, + "shopping_cart_display_price": 123, + "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": "abc123", - "store_name": "xyz789", + "store_group_code": "4", + "store_group_name": "xyz789", + "store_name": "abc123", "store_sort_order": 987, "timezone": "xyz789", - "title_separator": "xyz789", - "use_store_in_url": true, - "website_code": 4, - "website_name": "xyz789", + "title_separator": "abc123", + "use_store_in_url": false, + "website_code": "4", + "website_name": "abc123", "weight_unit": "xyz789", - "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": false, - "zero_subtotal_new_order_status": "xyz789", + "zero_subtotal_enable_for_specific_countries": true, + "zero_subtotal_enabled": true, + "zero_subtotal_new_order_status": "abc123", "zero_subtotal_payment_action": "abc123", - "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_payment_from_specific_countries": "xyz789", "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "abc123" + "zero_subtotal_title": "xyz789" } ] } @@ -609,7 +609,7 @@ query cart($cart_id: String!) { ##### Variables ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` ##### Response @@ -629,13 +629,13 @@ query cart($cart_id: String!) { ], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "has_available_free_gifts": true, - "id": "4", - "is_virtual": true, + "id": 4, + "is_virtual": false, "itemsV2": CartItems, "prices": CartPrices, "printed_card_included": false, @@ -701,7 +701,7 @@ query categories( ```json { - "ids": ["xyz789"], + "ids": ["abc123"], "roles": ["abc123"], "subtree": Subtree } @@ -716,18 +716,18 @@ query categories( { "availableSortBy": ["abc123"], "children": ["xyz789"], - "defaultSortBy": "abc123", + "defaultSortBy": "xyz789", "id": 4, "level": 123, - "name": "xyz789", + "name": "abc123", "parentId": "abc123", "position": 123, "path": "xyz789", "roles": ["abc123"], - "urlKey": "abc123", + "urlKey": "xyz789", "urlPath": "abc123", "count": 987, - "title": "xyz789" + "title": "abc123" } ] } @@ -767,10 +767,10 @@ query checkoutAgreements { "data": { "checkoutAgreements": [ { - "agreement_id": 987, + "agreement_id": 123, "checkbox_text": "abc123", "content": "xyz789", - "content_height": "xyz789", + "content_height": "abc123", "is_html": true, "mode": "AUTO", "name": "xyz789" @@ -803,7 +803,13 @@ query commerceOptimizer { ##### Response ```json -{"data": {"commerceOptimizer": {"priceBookId": 4}}} +{ + "data": { + "commerceOptimizer": { + "priceBookId": "4" + } + } +} ``` @@ -833,6 +839,9 @@ query company { available_shipping_methods { ...CompanyAvailableShippingMethodFragment } + catalogViewContext { + ...CatalogViewContextFragment + } company_admin { ...CustomerFragment } @@ -904,6 +913,7 @@ query company { "available_shipping_methods": [ CompanyAvailableShippingMethod ], + "catalogViewContext": CatalogViewContext, "company_admin": Customer, "config": CompanyConfig, "credit": CompanyCredit, @@ -912,12 +922,12 @@ query company { "default_billing_address": CompanyAddress, "default_shipping_address": CompanyAddress, "email": "xyz789", - "id": 4, + "id": "4", "legal_address": CompanyLegalAddress, "legal_name": "xyz789", "name": "abc123", "payment_methods": ["xyz789"], - "reseller_id": "xyz789", + "reseller_id": "abc123", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -926,7 +936,7 @@ query company { "team": CompanyTeam, "user": Customer, "users": CompanyUsers, - "vat_tax_id": "xyz789" + "vat_tax_id": "abc123" } } } @@ -980,7 +990,7 @@ query compareList($uid: ID!) { "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } } } @@ -1021,11 +1031,11 @@ query countries { "countries": [ { "available_regions": [Region], - "full_name_english": "xyz789", - "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "full_name_english": "abc123", + "full_name_locale": "abc123", + "id": "abc123", + "three_letter_abbreviation": "xyz789", + "two_letter_abbreviation": "abc123" } ] } @@ -1078,10 +1088,10 @@ query country($id: String) { "data": { "country": { "available_regions": [Region], - "full_name_english": "abc123", + "full_name_english": "xyz789", "full_name_locale": "xyz789", - "id": "xyz789", - "three_letter_abbreviation": "xyz789", + "id": "abc123", + "three_letter_abbreviation": "abc123", "two_letter_abbreviation": "xyz789" } } @@ -1122,10 +1132,10 @@ query currency { "data": { "currency": { "available_currency_codes": [ - "xyz789" + "abc123" ], - "base_currency_code": "xyz789", - "base_currency_symbol": "xyz789", + "base_currency_code": "abc123", + "base_currency_symbol": "abc123", "default_display_currency_code": "abc123", "default_display_currency_symbol": "xyz789", "exchange_rates": [ExchangeRate] @@ -1209,6 +1219,9 @@ query customer { ...AdminAssistanceActionsFragment } allow_remote_shopping_assistance + chain_totals { + ...OrderChainTotalFragment + } companies { ...UserCompaniesOutputFragment } @@ -1316,6 +1329,7 @@ query customer { "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, "allow_remote_shopping_assistance": true, + "chain_totals": OrderChainTotal, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, @@ -1323,27 +1337,27 @@ query customer { "created_at": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "abc123", - "default_billing": "abc123", + "default_billing": "xyz789", "default_shipping": "xyz789", - "email": "xyz789", + "email": "abc123", "firstname": "xyz789", - "gender": 987, + "gender": 123, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, - "id": 4, + "id": "4", "is_subscribed": false, - "job_title": "abc123", - "lastname": "abc123", - "middlename": "xyz789", + "job_title": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, - "prefix": "xyz789", + "prefix": "abc123", "purchase_order": PurchaseOrder, "purchase_order_approval_rule": PurchaseOrderApprovalRule, "purchase_order_approval_rule_metadata": PurchaseOrderApprovalRuleMetadata, "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, - "purchase_orders_enabled": true, + "purchase_orders_enabled": false, "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, @@ -1355,7 +1369,7 @@ query customer { "status": "ACTIVE", "store_credit": CustomerStoreCredit, "structure_id": "4", - "suffix": "abc123", + "suffix": "xyz789", "taxvat": "abc123", "team": CompanyTeam, "telephone": "xyz789", @@ -1459,7 +1473,7 @@ query customerCart { "custom_attributes": [CustomAttribute], "email": "xyz789", "gift_message": GiftMessage, - "gift_receipt_included": true, + "gift_receipt_included": false, "gift_wrapping": GiftWrapping, "has_available_free_gifts": true, "id": "4", @@ -1597,17 +1611,13 @@ query customerSegments($cartId: String!) { ##### Variables ```json -{"cartId": "abc123"} +{"cartId": "xyz789"} ``` ##### Response ```json -{ - "data": { - "customerSegments": [{"uid": "4"}] - } -} +{"data": {"customerSegments": [{"uid": 4}]}} ``` @@ -1714,7 +1724,7 @@ query getPaymentOrder( ```json { - "cartId": "xyz789", + "cartId": "abc123", "id": "xyz789" } ``` @@ -1726,7 +1736,7 @@ query getPaymentOrder( "data": { "getPaymentOrder": { "id": "xyz789", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, "status": "xyz789" } @@ -1855,7 +1865,7 @@ query giftCardAccount($input: GiftCardAccountInput!) { "data": { "giftCardAccount": { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "abc123" } } @@ -1921,20 +1931,20 @@ query giftRegistry($giftRegistryUid: ID!) { { "data": { "giftRegistry": { - "created_at": "xyz789", + "created_at": "abc123", "dynamic_attributes": [ GiftRegistryDynamicAttribute ], "event_name": "xyz789", "items": [GiftRegistryItemInterface], - "message": "abc123", - "owner_name": "abc123", + "message": "xyz789", + "owner_name": "xyz789", "privacy_settings": "PRIVATE", "registrants": [GiftRegistryRegistrant], "shipping_address": CustomerAddress, "status": "ACTIVE", "type": GiftRegistryType, - "uid": "4" + "uid": 4 } } } @@ -1974,7 +1984,7 @@ query giftRegistryEmailSearch($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response @@ -1984,10 +1994,10 @@ query giftRegistryEmailSearch($email: String!) { "data": { "giftRegistryEmailSearch": [ { - "event_date": "abc123", - "event_title": "abc123", + "event_date": "xyz789", + "event_title": "xyz789", "gift_registry_uid": "4", - "location": "abc123", + "location": "xyz789", "name": "abc123", "type": "xyz789" } @@ -2030,7 +2040,7 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { ##### Variables ```json -{"giftRegistryUid": 4} +{"giftRegistryUid": "4"} ``` ##### Response @@ -2041,11 +2051,11 @@ query giftRegistryIdSearch($giftRegistryUid: ID!) { "giftRegistryIdSearch": [ { "event_date": "xyz789", - "event_title": "xyz789", - "gift_registry_uid": 4, - "location": "xyz789", + "event_title": "abc123", + "gift_registry_uid": "4", + "location": "abc123", "name": "xyz789", - "type": "xyz789" + "type": "abc123" } ] } @@ -2099,7 +2109,7 @@ query giftRegistryTypeSearch( { "firstName": "xyz789", "lastName": "abc123", - "giftRegistryTypeUid": "4" + "giftRegistryTypeUid": 4 } ``` @@ -2111,11 +2121,11 @@ query giftRegistryTypeSearch( "giftRegistryTypeSearch": [ { "event_date": "xyz789", - "event_title": "abc123", + "event_title": "xyz789", "gift_registry_uid": 4, "location": "abc123", - "name": "abc123", - "type": "abc123" + "name": "xyz789", + "type": "xyz789" } ] } @@ -2156,8 +2166,8 @@ query giftRegistryTypes { "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "abc123", - "uid": "4" + "label": "xyz789", + "uid": 4 } ] } @@ -2274,7 +2284,7 @@ query guestOrder($input: GuestOrderInformationInput!) { "applied_gift_cards": [ApplyGiftCardToOrder], "available_actions": ["REORDER"], "billing_address": OrderAddress, - "carrier": "abc123", + "carrier": "xyz789", "comments": [SalesCommentItem], "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], @@ -2283,9 +2293,9 @@ query guestOrder($input: GuestOrderInformationInput!) { "gift_message": GiftMessage, "gift_receipt_included": false, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "invoices": [Invoice], - "is_virtual": true, + "is_virtual": false, "items": [OrderItemInterface], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, @@ -2293,13 +2303,13 @@ query guestOrder($input: GuestOrderInformationInput!) { "order_date": "abc123", "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "abc123", - "status": "abc123", - "token": "abc123", + "status": "xyz789", + "token": "xyz789", "total": OrderTotal } } @@ -2421,26 +2431,26 @@ query guestOrderByToken($input: OrderTokenInput!) { "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "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], "items_eligible_for_return": [OrderItemInterface], "negotiable_quote": NegotiableQuote, - "number": "xyz789", + "number": "abc123", "order_date": "xyz789", - "order_status_change_date": "abc123", + "order_status_change_date": "xyz789", "payment_methods": [OrderPaymentMethod], - "printed_card_included": false, + "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, - "shipping_method": "xyz789", - "status": "xyz789", + "shipping_method": "abc123", + "status": "abc123", "token": "xyz789", "total": OrderTotal } @@ -2483,7 +2493,7 @@ query isCompanyAdminEmailAvailable($email: String!) { ##### Response ```json -{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyAdminEmailAvailable": {"is_email_available": true}}} ``` @@ -2515,13 +2525,13 @@ query isCompanyEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyEmailAvailable": {"is_email_available": true}}} +{"data": {"isCompanyEmailAvailable": {"is_email_available": false}}} ``` @@ -2559,7 +2569,7 @@ query isCompanyRoleNameAvailable($name: String!) { ##### Response ```json -{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": false}}} +{"data": {"isCompanyRoleNameAvailable": {"is_role_name_available": true}}} ``` @@ -2591,13 +2601,13 @@ query isCompanyUserEmailAvailable($email: String!) { ##### Variables ```json -{"email": "abc123"} +{"email": "xyz789"} ``` ##### Response ```json -{"data": {"isCompanyUserEmailAvailable": {"is_email_available": false}}} +{"data": {"isCompanyUserEmailAvailable": {"is_email_available": true}}} ``` @@ -2629,7 +2639,7 @@ query isEmailAvailable($email: String!) { ##### Variables ```json -{"email": "xyz789"} +{"email": "abc123"} ``` ##### Response @@ -2723,8 +2733,8 @@ query isSubscribedProductAlertStock($input: ProductAlertStockInput!) { { "data": { "isSubscribedProductAlertStock": { - "isSubscribed": true, - "message": "abc123" + "isSubscribed": false, + "message": "xyz789" } } } @@ -2818,27 +2828,27 @@ query negotiableQuote($uid: ID!) { "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": true, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "order": CustomerOrder, "prices": CartPrices, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ NegotiableQuoteShippingAddress ], "status": "SUBMITTED", - "template_id": "4", + "template_id": 4, "template_name": "xyz789", "total_quantity": 123.45, - "uid": "4", - "updated_at": "abc123" + "uid": 4, + "updated_at": "xyz789" } } } @@ -2912,7 +2922,7 @@ query negotiableQuoteTemplate($templateId: ID!) { ##### Variables ```json -{"templateId": 4} +{"templateId": "4"} ``` ##### Response @@ -2927,11 +2937,11 @@ query negotiableQuoteTemplate($templateId: ID!) { "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], - "is_min_max_qty_used": false, + "is_min_max_qty_used": true, "is_virtual": true, "items": [CartItemInterface], - "max_order_commitment": 987, - "min_order_commitment": 123, + "max_order_commitment": 123, + "min_order_commitment": 987, "name": "xyz789", "notifications": [QuoteTemplateNotificationMessage], "prices": CartPrices, @@ -2944,8 +2954,8 @@ query negotiableQuoteTemplate($templateId: ID!) { ], "status": "abc123", "template_id": "4", - "total_quantity": 987.65, - "uid": 4, + "total_quantity": 123.45, + "uid": "4", "updated_at": "xyz789" } } @@ -3094,7 +3104,7 @@ query negotiableQuotes( "items": [NegotiableQuote], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 987 + "total_count": 123 } } } @@ -3338,8 +3348,8 @@ query productSearch( "items": [ProductSearchItem], "page_info": SearchResultPageInfo, "related_terms": ["xyz789"], - "suggestions": ["xyz789"], - "total_count": 123, + "suggestions": ["abc123"], + "total_count": 987, "warnings": [ProductSearchWarning] } } @@ -3381,6 +3391,14 @@ query products($skus: [String]) { videos { ...ProductViewVideoFragment } + gallery { + ... on ProductViewImage { + ...ProductViewImageFragment + } + ... on ProductViewVideo { + ...ProductViewVideoFragment + } + } lastModifiedAt metaDescription metaKeyword @@ -3421,24 +3439,25 @@ query products($skus: [String]) { { "addToCartAllowed": false, "inStock": false, - "lowStock": false, + "lowStock": true, "attributes": [ProductViewAttribute], "description": "xyz789", - "id": 4, + "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], + "gallery": [ProductViewImage], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", + "metaDescription": "abc123", "metaKeyword": "abc123", "metaTitle": "abc123", - "name": "abc123", - "shortDescription": "xyz789", + "name": "xyz789", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], - "sku": "xyz789", + "sku": "abc123", "externalId": "abc123", "externalIds": [ExternalId], "url": "xyz789", - "urlKey": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], "queryType": "abc123", "visibility": "abc123" @@ -3480,7 +3499,7 @@ query publicRequisitionList($token: ID!) { ##### Variables ```json -{"token": 4} +{"token": "4"} ``` ##### Response @@ -3490,7 +3509,7 @@ query publicRequisitionList($token: ID!) { "data": { "publicRequisitionList": { "requisition_list": RequisitionList, - "sender_name": "abc123" + "sender_name": "xyz789" } } } @@ -3536,7 +3555,7 @@ query recaptchaFormConfig($formType: ReCaptchaFormEnum!) { "data": { "recaptchaFormConfig": { "configurations": ReCaptchaConfiguration, - "is_enabled": true + "is_enabled": false } } } @@ -3587,7 +3606,7 @@ query recaptchaFormConfigs($formTypes: [ReCaptchaFormEnum!]!) { { "configurations": ReCaptchaConfiguration, "form_type": "PLACE_ORDER", - "is_enabled": false + "is_enabled": true } ] } @@ -3627,13 +3646,13 @@ query recaptchaV3Config { { "data": { "recaptchaV3Config": { - "badge_position": "abc123", + "badge_position": "xyz789", "failure_message": "abc123", "forms": ["PLACE_ORDER"], - "is_enabled": true, - "language_code": "xyz789", - "minimum_score": 987.65, - "theme": "abc123", + "is_enabled": false, + "language_code": "abc123", + "minimum_score": 123.45, + "theme": "xyz789", "website_key": "abc123" } } @@ -3699,8 +3718,8 @@ query recommendations( ```json { "cartSkus": ["xyz789"], - "category": "xyz789", - "currentSku": "xyz789", + "category": "abc123", + "currentSku": "abc123", "currentProduct": CurrentProductInput, "pageType": "CMS", "userPurchaseHistory": [PurchaseHistory], @@ -3773,7 +3792,7 @@ query recommendationsByUnits( ```json { "selector": UnitSelector, - "currentSku": "xyz789", + "currentSku": "abc123", "currentProduct": CurrentProductInput, "userPurchaseHistory": [PurchaseHistory], "userViewHistory": [ViewHistory], @@ -3836,6 +3855,14 @@ query refineProduct( videos { ...ProductViewVideoFragment } + gallery { + ... on ProductViewImage { + ...ProductViewImageFragment + } + ... on ProductViewVideo { + ...ProductViewVideoFragment + } + } lastModifiedAt metaDescription metaKeyword @@ -3865,7 +3892,7 @@ query refineProduct( ```json { - "optionIds": ["abc123"], + "optionIds": ["xyz789"], "sku": "xyz789" } ``` @@ -3877,28 +3904,29 @@ query refineProduct( "data": { "refineProduct": { "addToCartAllowed": false, - "inStock": false, - "lowStock": false, + "inStock": true, + "lowStock": true, "attributes": [ProductViewAttribute], - "description": "xyz789", + "description": "abc123", "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], + "gallery": [ProductViewImage], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "abc123", - "metaKeyword": "abc123", + "metaDescription": "xyz789", + "metaKeyword": "xyz789", "metaTitle": "xyz789", - "name": "abc123", + "name": "xyz789", "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], - "sku": "abc123", + "sku": "xyz789", "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", - "urlKey": "xyz789", + "url": "abc123", + "urlKey": "abc123", "links": [ProductViewLink], "queryType": "xyz789", - "visibility": "abc123" + "visibility": "xyz789" } } } @@ -4010,7 +4038,7 @@ query sharedRequisitionList($token: String!) { "data": { "sharedRequisitionList": { "requisition_list": RequisitionList, - "sender_name": "xyz789" + "sender_name": "abc123" } } } @@ -4020,7 +4048,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. Only SKUs of products the shopper may see in the current website's catalog are reported. +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. Per-source availability is a physical snapshot, not a purchasable-quantity limit: use stockAvailability for the salable quantity and the Add to Cart gate. Returns an empty list when per-source disclosure is not enabled for the store (cataloginventory/source_availability/storefront_enabled off). **Response:** [`[SkuSourceAvailability]!`](/reference/graphql/saas/types-q-s.md#skusourceavailability) @@ -4028,7 +4056,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. 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. | +| `skus` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | The product SKUs to report availability for, at most 100. 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. | @@ -4047,8 +4075,6 @@ query sourceAvailability( source_codes: $source_codes, only_in_stock: $only_in_stock ) { - backorder_message - is_saleable sku sources { ...SourceAvailabilityFragment @@ -4062,7 +4088,7 @@ query sourceAvailability( ```json { "skus": ["abc123"], - "source_codes": ["abc123"], + "source_codes": ["xyz789"], "only_in_stock": false } ``` @@ -4074,9 +4100,7 @@ query sourceAvailability( "data": { "sourceAvailability": [ { - "backorder_message": "xyz789", - "is_saleable": false, - "sku": "abc123", + "sku": "xyz789", "sources": [SourceAvailability] } ] @@ -4086,6 +4110,60 @@ query sourceAvailability( +### stockAvailability + +Stock-level salable quantity and purchase eligibility for one or more SKUs, evaluated against the current sales channel's stock. Read directly from the inventory and reservation tables, so it is strongly consistent with what the cart enforces at add-to-cart and order placement, and accounts for every open reservation — including orders placed without a nominated source, which per-source availability cannot attribute to any one source. Can be combined with sourceAvailability in a single request. Only SKUs of products the shopper may see in the current website's catalog are reported. + +**Response:** [`[StockAvailability]!`](/reference/graphql/saas/types-q-s.md#stockavailability) + +#### Arguments + +| Name | Description | +|------|-------------| +| `skus` - [`[String!]!`](/reference/graphql/saas/types-q-s.md#string) | The product SKUs to report availability for, at most 100. 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. | + +#### Example + +##### Query + +```graphql +query stockAvailability($skus: [String!]!) { + stockAvailability(skus: $skus) { + backorder_message + is_in_stock + is_salable + salable_qty + sku + } +} +``` + +##### Variables + +```json +{"skus": ["xyz789"]} +``` + +##### Response + +```json +{ + "data": { + "stockAvailability": [ + { + "backorder_message": "abc123", + "is_in_stock": false, + "is_salable": false, + "salable_qty": 123.45, + "sku": "abc123" + } + ] + } +} +``` + + + ### storeConfig Return details about the store's configuration. @@ -4271,162 +4349,162 @@ query storeConfig { "data": { "storeConfig": { "allow_company_registration": false, - "allow_gift_receipt": "abc123", + "allow_gift_receipt": "xyz789", "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": "xyz789", - "autocomplete_on_storefront": true, + "allow_gift_wrapping_on_order_items": "abc123", + "allow_guests_to_write_product_reviews": "abc123", + "allow_items": "xyz789", + "allow_order": "xyz789", + "allow_printed_card": "abc123", + "autocomplete_on_storefront": false, "base_currency_code": "abc123", "base_link_url": "xyz789", "base_media_url": "abc123", "base_static_url": "abc123", "base_url": "xyz789", - "cart_expires_in_days": 987, + "cart_expires_in_days": 123, "cart_gift_wrapping": "abc123", - "cart_merge_preference": "xyz789", - "cart_printed_card": "abc123", + "cart_merge_preference": "abc123", + "cart_printed_card": "xyz789", "cart_summary_display_quantity": 987, - "catalog_default_sort_by": "xyz789", + "catalog_default_sort_by": "abc123", "category_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "category_url_suffix": "abc123", - "check_money_order_enable_for_specific_countries": false, - "check_money_order_enabled": true, - "check_money_order_make_check_payable_to": "xyz789", + "category_url_suffix": "xyz789", + "check_money_order_enable_for_specific_countries": true, + "check_money_order_enabled": false, + "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_new_order_status": "abc123", "check_money_order_payment_from_specific_countries": "abc123", "check_money_order_send_check_to": "abc123", - "check_money_order_sort_order": 123, + "check_money_order_sort_order": 987, "check_money_order_title": "xyz789", "company_credit_enabled": false, - "company_enabled": true, + "company_enabled": false, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, - "countries_with_required_region": "xyz789", + "contact_enabled": false, + "countries_with_required_region": "abc123", "create_account_confirmation": false, "customer_access_token_lifetime": 123.45, "default_country": "abc123", - "default_display_currency_code": "abc123", + "default_display_currency_code": "xyz789", "display_product_prices_in_catalog": 123, "display_shipping_prices": 987, - "display_state_if_optional": false, + "display_state_if_optional": true, "enable_multiple_wishlists": "xyz789", - "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_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_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": true, + "fixed_product_taxes_enable": false, "fixed_product_taxes_include_fpt_in_subtotal": false, "graphql_share_customer_group": false, - "grid_per_page": 987, - "grid_per_page_values": "abc123", + "grid_per_page": 123, + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", - "is_checkout_agreements_enabled": true, + "is_checkout_agreements_enabled": false, "is_default_store": true, "is_default_store_group": false, "is_guest_checkout_enabled": false, - "is_negotiable_quote_active": false, - "is_one_page_checkout_enabled": false, + "is_negotiable_quote_active": true, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "abc123", - "list_mode": "abc123", - "list_per_page": 987, + "list_mode": "xyz789", + "list_per_page": 123, "list_per_page_values": "xyz789", - "locale": "abc123", + "locale": "xyz789", "magento_reward_general_is_enabled": "xyz789", - "magento_reward_general_is_enabled_on_front": "xyz789", - "magento_reward_general_min_points_balance": "abc123", + "magento_reward_general_is_enabled_on_front": "abc123", + "magento_reward_general_min_points_balance": "xyz789", "magento_reward_general_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "abc123", - "magento_reward_points_invitation_customer_limit": "xyz789", - "magento_reward_points_invitation_order": "abc123", - "magento_reward_points_invitation_order_limit": "xyz789", - "magento_reward_points_newsletter": "abc123", + "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer_limit": "abc123", + "magento_reward_points_invitation_order": "xyz789", + "magento_reward_points_invitation_order_limit": "abc123", + "magento_reward_points_newsletter": "xyz789", "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", - "magento_reward_points_review": "xyz789", + "magento_reward_points_review": "abc123", "magento_reward_points_review_limit": "xyz789", - "magento_wishlist_general_is_enabled": "xyz789", - "max_items_in_order_summary": 123, - "maximum_number_of_wishlists": "xyz789", - "minicart_display": true, + "magento_wishlist_general_is_enabled": "abc123", + "max_items_in_order_summary": 987, + "maximum_number_of_wishlists": "abc123", + "minicart_display": false, "minicart_max_items": 987, - "minimum_password_length": "xyz789", + "minimum_password_length": "abc123", "newsletter_enabled": false, - "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "optional_zip_countries": "xyz789", + "order_cancellation_enabled": true, "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": 987, - "orders_invoices_credit_memos_display_shipping_amount": 987, + "orders_invoices_credit_memos_display_full_summary": false, + "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": true, - "persistent_enabled": false, + "persistent_enabled": true, "persistent_options_wishlist": true, "persistent_shopping_cart": false, "printed_card_priceV2": Money, "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": true, - "quote_minimum_amount": 123.45, - "quote_minimum_amount_message": "xyz789", - "required_character_classes_number": "xyz789", + "product_url_suffix": "xyz789", + "quickorder_active": false, + "quote_minimum_amount": 987.65, + "quote_minimum_amount_message": "abc123", + "required_character_classes_number": "abc123", "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_share_max_recipients": 123, + "requisition_list_public_share_storefront_path": "xyz789", "requisition_list_public_sharing_enabled": true, - "requisition_list_share_link_validity_days": 987, + "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": "abc123", + "requisition_list_share_storefront_path": "abc123", + "requisition_list_sharing_enabled": false, + "returns_enabled": "xyz789", "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "abc123", - "sales_printed_card": "abc123", - "secure_base_link_url": "abc123", - "secure_base_media_url": "abc123", + "sales_gift_wrapping": "xyz789", + "sales_printed_card": "xyz789", + "secure_base_link_url": "xyz789", + "secure_base_media_url": "xyz789", "secure_base_static_url": "xyz789", - "secure_base_url": "abc123", - "share_active_segments": false, - "share_applied_cart_rule": false, + "secure_base_url": "xyz789", + "share_active_segments": true, + "share_applied_cart_rule": true, "share_customer_accounts_scope": 123, - "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "xyz789", "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, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", - "shopping_cart_display_zero_tax": false, - "store_code": 4, - "store_group_code": 4, + "shopping_cart_display_zero_tax": true, + "store_code": "4", + "store_group_code": "4", "store_group_name": "xyz789", "store_name": "xyz789", "store_sort_order": 123, "timezone": "abc123", "title_separator": "abc123", "use_store_in_url": true, - "website_code": 4, + "website_code": "4", "website_name": "xyz789", - "weight_unit": "abc123", + "weight_unit": "xyz789", "zero_subtotal_enable_for_specific_countries": false, - "zero_subtotal_enabled": true, + "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "abc123", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 123, - "zero_subtotal_title": "abc123" + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 987, + "zero_subtotal_title": "xyz789" } } } @@ -4476,8 +4554,8 @@ query variants( ```json { - "sku": "xyz789", - "optionIds": ["abc123"], + "sku": "abc123", + "optionIds": ["xyz789"], "pageSize": 123, "cursor": "xyz789" } 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 e02e92ec6..87ce41e3d 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 @@ -96,7 +96,7 @@ Defines a new registrant. ], "email": "abc123", "firstname": "abc123", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -156,7 +156,10 @@ Contains products to add to an existing compare list. #### Example ```json -{"products": [4], "uid": 4} +{ + "products": ["4"], + "uid": "4" +} ``` @@ -239,8 +242,8 @@ An input object that identifies the public requisition list, the target cart, an ```json { - "cart_id": "xyz789", - "item_uids": ["4"], + "cart_id": "abc123", + "item_uids": [4], "token": "4" } ``` @@ -285,7 +288,7 @@ Contains the comment to be added to a purchase order. ```json { "comment": "xyz789", - "purchase_order_uid": 4 + "purchase_order_uid": "4" } ``` @@ -325,9 +328,9 @@ Defines the purchase order and cart to act on. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "purchase_order_uid": 4, - "replace_existing_cart_items": false + "replace_existing_cart_items": true } ``` @@ -394,7 +397,7 @@ Output of the request to add items in a requisition list to the cart. AddRequisitionListItemToCartUserError ], "cart": Cart, - "status": true + "status": false } ``` @@ -454,7 +457,7 @@ Defines tracking information to be added to the return. ```json { "carrier_uid": 4, - "return_uid": "4", + "return_uid": 4, "tracking_number": "xyz789" } ``` @@ -502,7 +505,7 @@ Contains the resultant wish list and any error information. "add_wishlist_items_to_cart_user_errors": [ WishlistCartUserInputError ], - "status": false, + "status": true, "wishlist": Wishlist } ``` @@ -525,7 +528,7 @@ A single admin assistance action performed on behalf of the customer. ```json { - "action": "abc123", + "action": "xyz789", "date": "xyz789", "details": "abc123" } @@ -574,7 +577,7 @@ A bucket that contains information for each filterable option ```json { - "attribute": "abc123", + "attribute": "xyz789", "buckets": [Bucket], "title": "abc123", "type": "INTELLIGENT" @@ -628,7 +631,7 @@ Identifies the data type of the aggregation "payment_intent": "abc123", "payment_source": "xyz789", "sdk_params": [SDKParams], - "sort_order": "xyz789", + "sort_order": "abc123", "title": "abc123" } ``` @@ -651,9 +654,9 @@ Apple Pay inputs ```json { - "payment_source": "xyz789", + "payment_source": "abc123", "payments_order_id": "xyz789", - "paypal_order_id": "xyz789" + "paypal_order_id": "abc123" } ``` @@ -672,7 +675,7 @@ Contains the applied coupon code. #### Example ```json -{"code": "abc123"} +{"code": "xyz789"} ``` @@ -695,9 +698,9 @@ Contains an applied gift card with applied and remaining balance. ```json { "applied_balance": Money, - "code": "abc123", + "code": "xyz789", "current_balance": Money, - "expiration_date": "xyz789" + "expiration_date": "abc123" } ``` @@ -721,7 +724,7 @@ The rule that was applied to this product { "action_type": "BOOST", "rule_id": "xyz789", - "rule_name": "xyz789" + "rule_name": "abc123" } ``` @@ -846,7 +849,7 @@ Apply coupons to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "coupon_codes": ["abc123"], "type": "APPEND" } @@ -870,7 +873,7 @@ Defines the input required to run the `applyGiftCardToCart` mutation. ```json { "cart_id": "abc123", - "gift_card_code": "abc123" + "gift_card_code": "xyz789" } ``` @@ -910,7 +913,7 @@ Contains applied gift cards with gift card code and amount. ```json { "applied_balance": Money, - "code": "xyz789" + "code": "abc123" } ``` @@ -1009,7 +1012,7 @@ Contains information about an asset image. ```json { "asset_image": ProductMediaGalleryEntriesAssetImage, - "disabled": true, + "disabled": false, "label": "xyz789", "position": 123, "types": ["abc123"], @@ -1039,10 +1042,10 @@ Contains information about an asset video. ```json { "asset_video": ProductMediaGalleryEntriesAssetVideo, - "disabled": false, - "label": "abc123", + "disabled": true, + "label": "xyz789", "position": 987, - "types": ["abc123"], + "types": ["xyz789"], "url": "abc123" } ``` @@ -1064,8 +1067,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 } ``` @@ -1103,7 +1106,7 @@ Contains the results of the request to assign a compare list. #### Example ```json -{"compare_list": CompareList, "result": true} +{"compare_list": CompareList, "result": false} ``` @@ -1145,8 +1148,8 @@ List of all entity types. Populated by the modules introducing EAV entities. ```json { - "attribute_type": "abc123", - "code": "4", + "attribute_type": "xyz789", + "code": 4, "url": "abc123", "value": "abc123" } @@ -1180,17 +1183,17 @@ An input object that specifies the filters used for attributes. ```json { "is_comparable": true, - "is_filterable": false, + "is_filterable": true, "is_filterable_in_search": false, - "is_html_allowed_on_front": false, - "is_searchable": false, + "is_html_allowed_on_front": true, + "is_searchable": true, "is_used_for_customer_segment": false, - "is_used_for_price_rules": false, + "is_used_for_price_rules": true, "is_used_for_promo_rules": true, "is_visible_in_advanced_search": true, "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "used_in_product_listing": true + "is_wysiwyg_enabled": false, + "used_in_product_listing": false } ``` @@ -1245,9 +1248,9 @@ EAV attribute frontend input types. ```json { "attribute_type": "abc123", - "code": 4, - "url": "abc123", - "value": "xyz789" + "code": "4", + "url": "xyz789", + "value": "abc123" } ``` @@ -1268,7 +1271,7 @@ Defines the attribute characteristics to search for the `attribute_code` and `en ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "entity_type": "abc123" } ``` @@ -1288,7 +1291,7 @@ Specifies selected option for a select or multiselect attribute value. #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -1315,14 +1318,14 @@ Base EAV implementation of CustomAttributeMetadataInterface. ```json { - "code": 4, - "default_value": "abc123", + "code": "4", + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_required": true, "is_unique": true, - "label": "abc123", + "label": "xyz789", "options": [CustomAttributeOptionInterface] } ``` @@ -1410,9 +1413,9 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "is_default": true, + "is_default": false, "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1431,7 +1434,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "attributeName": "xyz789", + "attributeName": "abc123", "value": RangeValueInput } ``` @@ -1452,7 +1455,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -1478,7 +1481,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "label": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -1499,7 +1502,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { "attribute_type": "abc123", - "code": 4, + "code": "4", "selected_options": [AttributeSelectedOptionInterface] } ``` @@ -1519,7 +1522,7 @@ Base EAV implementation of CustomAttributeOptionInterface. ```json { - "attributeName": "xyz789", + "attributeName": "abc123", "values": ["xyz789"] } ``` @@ -1564,9 +1567,9 @@ Specifies the value for attribute. ```json { - "attribute_code": "xyz789", + "attribute_code": "abc123", "selected_options": [AttributeInputSelectedOption], - "value": "abc123" + "value": "xyz789" } ``` @@ -1595,7 +1598,10 @@ Specifies the value for attribute. #### Example ```json -{"attribute_type": "xyz789", "code": 4} +{ + "attribute_type": "abc123", + "code": "4" +} ``` @@ -1674,7 +1680,7 @@ Defines the code and symbol of a currency that can be used for purchase orders. #### Example ```json -{"code": "AFN", "symbol": "abc123"} +{"code": "AFN", "symbol": "xyz789"} ``` @@ -1700,8 +1706,8 @@ A free-gift cart price rule that has not yet had a gift added because the custom "available_skus": ["abc123"], "gift_qty": 987, "products": [ProductInterface], - "rule_id": 987, - "rule_label": "xyz789" + "rule_id": 123, + "rule_label": "abc123" } ``` @@ -1725,9 +1731,9 @@ Describes a payment method that the shopper can use to pay for the order. ```json { "code": "abc123", - "is_deferred": true, + "is_deferred": false, "oope_payment_method_config": OopePaymentMethodConfig, - "title": "xyz789" + "title": "abc123" } ``` @@ -1758,12 +1764,12 @@ Contains details about the possible shipping methods and carriers. { "additional_data": [ShippingAdditionalData], "amount": Money, - "available": true, + "available": false, "carrier_code": "xyz789", "carrier_title": "abc123", - "error_message": "abc123", - "method_code": "abc123", - "method_title": "abc123", + "error_message": "xyz789", + "method_code": "xyz789", + "method_title": "xyz789", "price_excl_tax": Money, "price_incl_tax": Money } @@ -1809,10 +1815,10 @@ Defines the billing address. ```json { "address": CartAddressInput, - "company_address_id": "4", + "company_address_id": 4, "customer_address_id": 123, - "customer_address_uid": "4", - "same_as_shipping": true, + "customer_address_uid": 4, + "same_as_shipping": false, "use_for_shipping": true } ``` @@ -1839,11 +1845,11 @@ The billing address information ```json { "address_line_1": "abc123", - "address_line_2": "xyz789", + "address_line_2": "abc123", "city": "abc123", "country_code": "xyz789", - "postal_code": "xyz789", - "region": "xyz789" + "postal_code": "abc123", + "region": "abc123" } ``` @@ -1881,21 +1887,21 @@ Contains details about the billing address. ```json { - "city": "abc123", - "company": "xyz789", + "city": "xyz789", + "company": "abc123", "company_address_id": 4, "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "abc123", + "fax": "abc123", + "firstname": "xyz789", "id": 123, - "lastname": "abc123", - "middlename": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": CartAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "abc123", "uid": 4, @@ -1929,10 +1935,10 @@ Contains details about an individual category that comprises a breadcrumb. ```json { - "category_level": 123, - "category_name": "xyz789", + "category_level": 987, + "category_name": "abc123", "category_uid": "4", - "category_url_key": "xyz789", + "category_url_key": "abc123", "category_url_path": "abc123" } ``` @@ -1962,7 +1968,7 @@ An interface for bucket contents #### Example ```json -{"title": "xyz789"} +{"title": "abc123"} ``` @@ -2012,19 +2018,19 @@ An implementation for bundle product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, "is_free_gift": true, - "is_salable": true, - "max_qty": 123.45, - "min_qty": 987.65, + "is_salable": false, + "max_qty": 987.65, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -2061,7 +2067,7 @@ Defines bundle product options for `CreditMemoItemInterface`. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "xyz789", - "quantity_refunded": 987.65 + "quantity_refunded": 123.45 } ``` @@ -2096,8 +2102,8 @@ Defines bundle product options for `InvoiceItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_invoiced": 123.45 + "product_sku": "xyz789", + "quantity_invoiced": 987.65 } ``` @@ -2125,11 +2131,11 @@ Defines an individual item within a bundle product. ```json { "options": [BundleItemOption], - "position": 123, + "position": 987, "price_range": PriceRange, "required": false, "sku": "abc123", - "title": "xyz789", + "title": "abc123", "type": "xyz789", "uid": "4" } @@ -2221,23 +2227,23 @@ Defines bundle product options for `OrderItemInterface`. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "id": "4", - "parent_sku": "xyz789", + "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "abc123", "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 123.45, "quantity_returned": 123.45, - "quantity_shipped": 987.65, + "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2313,26 +2319,26 @@ Defines basic features of a bundle product and contains multiple BundleItems. "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "dynamic_price": false, - "dynamic_sku": true, - "dynamic_weight": false, + "dynamic_price": true, + "dynamic_sku": false, + "dynamic_weight": true, "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "items": [BundleItem], - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "xyz789", + "meta_keyword": "abc123", "meta_title": "abc123", - "min_sale_qty": 123.45, + "min_sale_qty": 987.65, "name": "xyz789", "new_from_date": "xyz789", - "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "new_to_date": "abc123", + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_details": PriceDetails, @@ -2343,21 +2349,21 @@ Defines basic features of a bundle product and contains multiple BundleItems. "quantity": 987.65, "rating_summary": 123.45, "related_products": [ProductInterface], - "review_count": 987, + "review_count": 123, "reviews": ProductReviews, "ship_bundle_items": "TOGETHER", "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123", - "weight": 987.65 + "url_key": "xyz789", + "weight": 123.45 } ``` @@ -2385,8 +2391,8 @@ Contains details about bundle products added to a requisition list. "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, - "quantity": 123.45, - "sku": "abc123", + "quantity": 987.65, + "sku": "xyz789", "uid": 4 } ``` @@ -2418,7 +2424,7 @@ Defines bundle product options for `ShipmentItemInterface`. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_shipped": 987.65 } ``` @@ -2445,13 +2451,13 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "added_at": "xyz789", + "added_at": "abc123", "bundle_options": [SelectedBundleOption], "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -2475,12 +2481,12 @@ Defines bundle product options for `WishlistItemInterface`. ```json { - "color": "xyz789", - "height": 123, - "label": "xyz789", - "layout": "xyz789", + "color": "abc123", + "height": 987, + "label": "abc123", + "layout": "abc123", "shape": "abc123", - "tagline": false, + "tagline": true, "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 393cf7be9..f6ac7297c 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 @@ -16,7 +16,7 @@ Specifies the quote template id of the quote template to cancel ```json { "cancellation_comment": "abc123", - "template_id": 4 + "template_id": "4" } ``` @@ -101,7 +101,7 @@ Contains the updated customer order and error message if any. ```json { - "error": "abc123", + "error": "xyz789", "errorV2": CancelOrderError, "order": CustomerOrder } @@ -144,10 +144,10 @@ Contains the updated customer order and error message if any. { "authentication_result": AuthenticationResult, "bin_details": CardBin, - "card_expiry_month": "abc123", - "card_expiry_year": "xyz789", - "last_digits": "xyz789", - "name": "abc123" + "card_expiry_month": "xyz789", + "card_expiry_year": "abc123", + "last_digits": "abc123", + "name": "xyz789" } ``` @@ -208,7 +208,7 @@ The card payment source information ```json { "brand": "abc123", - "expiry": "xyz789", + "expiry": "abc123", "last_digits": "xyz789" } ``` @@ -260,16 +260,16 @@ Contains the contents and other details about a guest or customer cart. "available_payment_methods": [AvailablePaymentMethod], "billing_address": BillingCartAddress, "custom_attributes": [CustomAttribute], - "email": "xyz789", + "email": "abc123", "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": true, + "printed_card_included": false, "rules": [CartRuleStorefront], "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [ShippingCartAddress], @@ -295,7 +295,7 @@ Contains details the country in a billing or shipping address. ```json { "code": "xyz789", - "label": "abc123" + "label": "xyz789" } ``` @@ -324,7 +324,7 @@ Defines the billing or shipping address to be applied to the cart. | `save_in_address_book` - [`Boolean`](/reference/graphql/saas/types-a-b.md#boolean) | Determines whether to save the address in the customer's address book. The default value is true. | | `street` - [`[String]!`](/reference/graphql/saas/types-q-s.md#string) | An array containing the street for the billing or shipping address. | | `suffix` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A value such as Sr., Jr., or III. | -| `telephone` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | +| `telephone` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The telephone number for the billing or shipping address. | | `vat_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The VAT company number for billing or shipping address. | #### Example @@ -333,20 +333,20 @@ Defines the billing or shipping address to be applied to the cart. { "city": "xyz789", "company": "abc123", - "country_code": "xyz789", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "xyz789", "firstname": "abc123", "lastname": "xyz789", "middlename": "abc123", "postcode": "abc123", - "prefix": "xyz789", + "prefix": "abc123", "region": "xyz789", "region_id": 123, "save_in_address_book": true, "street": ["abc123"], - "suffix": "xyz789", - "telephone": "abc123", + "suffix": "abc123", + "telephone": "xyz789", "vat_id": "xyz789" } ``` @@ -399,15 +399,15 @@ Defines the billing or shipping address to be applied to the cart. "fax": "xyz789", "firstname": "abc123", "id": 987, - "lastname": "xyz789", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "xyz789", + "lastname": "abc123", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "abc123", "region": CartAddressRegion, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "abc123", - "uid": 4, + "uid": "4", "vat_id": "xyz789" } ``` @@ -431,7 +431,7 @@ Contains details about the region in a billing or shipping address. ```json { "code": "abc123", - "label": "xyz789", + "label": "abc123", "region_id": 987 } ``` @@ -493,7 +493,7 @@ Defines a cart item custom attributes. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "cart_item_id": "xyz789", "custom_attributes": [CustomAttributeInput] } @@ -556,7 +556,7 @@ Defines an item to be added to the cart. { "entered_options": [EnteredOptionInput], "parent_sku": "abc123", - "quantity": 987.65, + "quantity": 123.45, "selected_options": ["4"], "sku": "xyz789" } @@ -610,11 +610,11 @@ An interface for products in a cart. "custom_attributes": [CustomAttribute], "discount": [Discount], "errors": [CartItemError], - "is_available": true, + "is_available": false, "is_free_gift": false, - "is_salable": true, - "max_qty": 987.65, - "min_qty": 987.65, + "is_salable": false, + "max_qty": 123.45, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "abc123", @@ -622,7 +622,7 @@ An interface for products in a cart. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "uid": 4 } ``` @@ -715,7 +715,7 @@ A single item to be updated. "customizable_options": [CustomizableOptionInput], "gift_message": GiftMessageInput, "gift_wrapping_id": "4", - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -920,29 +920,49 @@ Swatch attribute metadata. ```json { "apply_to": ["SIMPLE"], - "code": "4", - "default_value": "abc123", + "code": 4, + "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "is_comparable": true, - "is_filterable": true, + "is_filterable": false, "is_filterable_in_search": true, - "is_html_allowed_on_front": false, - "is_required": true, - "is_searchable": false, + "is_html_allowed_on_front": true, + "is_required": false, + "is_searchable": true, "is_unique": false, - "is_used_for_price_rules": false, - "is_used_for_promo_rules": true, + "is_used_for_price_rules": true, + "is_used_for_promo_rules": false, "is_visible_in_advanced_search": true, - "is_visible_on_front": false, - "is_wysiwyg_enabled": true, - "label": "abc123", + "is_visible_on_front": true, + "is_wysiwyg_enabled": false, + "label": "xyz789", "options": [CustomAttributeOptionInterface], "swatch_input_type": "BOOLEAN", "update_product_preview_image": false, - "use_product_image_for_swatch": false, - "used_in_product_listing": true + "use_product_image_for_swatch": true, + "used_in_product_listing": false +} +``` + + + +### CatalogViewContext + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `accessToken` - [`String`](/reference/graphql/saas/types-q-s.md#string) | RS256-signed access token (exp-only) authorizing the catalog view scope. Null when issuance is disabled or no active signing key is available. | +| `catalogViewId` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | ACO Catalog View id for the company's entitled catalog view. | + +#### Example + +```json +{ + "accessToken": "xyz789", + "catalogViewId": "xyz789" } ``` @@ -966,8 +986,8 @@ New category bucket for federation ```json { "count": 123, - "id": 4, - "path": "xyz789", + "id": "4", + "path": "abc123", "title": "abc123" } ``` @@ -991,7 +1011,7 @@ New category bucket for federation #### Example ```json -{"id": 4} +{"id": "4"} ``` @@ -1040,25 +1060,25 @@ Contains the full set of attributes that can be returned in a category search. ```json { - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], - "canonical_url": "xyz789", - "children_count": "xyz789", - "custom_layout_update_file": "xyz789", - "default_sort_by": "xyz789", - "description": "abc123", - "display_mode": "xyz789", + "canonical_url": "abc123", + "children_count": "abc123", + "custom_layout_update_file": "abc123", + "default_sort_by": "abc123", + "description": "xyz789", + "display_mode": "abc123", "filter_price_range": 123.45, "image": "xyz789", - "include_in_menu": 987, + "include_in_menu": 123, "is_anchor": 987, - "landing_page": 123, - "level": 987, - "meta_description": "xyz789", - "meta_keywords": "xyz789", - "meta_title": "xyz789", + "landing_page": 987, + "level": 123, + "meta_description": "abc123", + "meta_keywords": "abc123", + "meta_title": "abc123", "name": "abc123", - "path": "xyz789", + "path": "abc123", "path_in_store": "abc123", "position": 987, "product_count": 987, @@ -1108,31 +1128,31 @@ Contains the hierarchy of categories. ```json { - "available_sort_by": ["xyz789"], + "available_sort_by": ["abc123"], "breadcrumbs": [Breadcrumb], "canonical_url": "abc123", - "children_count": "xyz789", + "children_count": "abc123", "custom_layout_update_file": "xyz789", "default_sort_by": "xyz789", "description": "xyz789", "display_mode": "abc123", "filter_price_range": 987.65, - "image": "xyz789", - "include_in_menu": 987, + "image": "abc123", + "include_in_menu": 123, "is_anchor": 987, - "landing_page": 987, - "level": 123, - "meta_description": "abc123", + "landing_page": 123, + "level": 987, + "meta_description": "xyz789", "meta_keywords": "xyz789", - "meta_title": "abc123", - "name": "abc123", + "meta_title": "xyz789", + "name": "xyz789", "path": "xyz789", - "path_in_store": "abc123", - "position": 123, + "path_in_store": "xyz789", + "position": 987, "product_count": 123, - "uid": 4, + "uid": "4", "url_key": "abc123", - "url_path": "xyz789" + "url_path": "abc123" } ``` @@ -1167,17 +1187,17 @@ Represents a category. Contains information about a category, including the cate { "availableSortBy": ["xyz789"], "children": ["xyz789"], - "defaultSortBy": "abc123", + "defaultSortBy": "xyz789", "id": "4", "level": 123, "name": "xyz789", - "parentId": "abc123", + "parentId": "xyz789", "position": 987, - "path": "xyz789", + "path": "abc123", "roles": ["xyz789"], - "urlKey": "abc123", + "urlKey": "xyz789", "urlPath": "xyz789", - "count": 987, + "count": 123, "title": "abc123" } ``` @@ -1214,7 +1234,7 @@ Base interface defining essential category fields shared across all category vie { "availableSortBy": ["xyz789"], "defaultSortBy": "abc123", - "id": "4", + "id": 4, "level": 987, "name": "xyz789", "path": "abc123", @@ -1250,9 +1270,9 @@ Defines details about an individual checkout agreement. "checkbox_text": "xyz789", "content": "abc123", "content_height": "xyz789", - "is_html": true, + "is_html": false, "mode": "AUTO", - "name": "abc123" + "name": "xyz789" } ``` @@ -1294,8 +1314,8 @@ An error encountered while adding an item to the cart. ```json { "code": "REORDER_NOT_AVAILABLE", - "message": "xyz789", - "path": ["abc123"] + "message": "abc123", + "path": ["xyz789"] } ``` @@ -1335,7 +1355,7 @@ Contains details about errors encountered when a customer clear cart. #### Example ```json -{"message": "abc123", "type": "NOT_FOUND"} +{"message": "xyz789", "type": "NOT_FOUND"} ``` @@ -1372,7 +1392,7 @@ Assigns a specific `cart_id` to the empty cart. #### Example ```json -{"uid": "4"} +{"uid": 4} ``` @@ -1413,7 +1433,7 @@ Output of the request to clear the customer cart. #### Example ```json -{"cart": Cart, "status": true} +{"cart": Cart, "status": false} ``` @@ -1452,7 +1472,7 @@ Contains details about a failed close operation on a negotiable quote. ```json { "errors": [NegotiableQuoteInvalidStateError], - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -1602,6 +1622,7 @@ Contains the output schema for a company. | `addresses` - [`CompanyAddresses!`](#companyaddresses) | A paginated list of company addresses assigned to the company. | | `available_payment_methods` - [`[AvailablePaymentMethod]`](/reference/graphql/saas/types-a-b.md#availablepaymentmethod) | Available payment methods for the company with proper B2B configuration and company-specific filtering. | | `available_shipping_methods` - [`[CompanyAvailableShippingMethod]`](#companyavailableshippingmethod) | Available shipping carriers for the company with proper B2B configuration and company-specific filtering. | +| `catalogViewContext` - [`CatalogViewContext`](#catalogviewcontext) | ACO catalog-view runtime context (view id + signed access token) for this company. Null when the company has no entitled catalog view or the caller is not an authenticated company customer. | | `company_admin` - [`Customer`](#customer) | An object containing information about the company administrator. | | `config` - [`CompanyConfig!`](#companyconfig) | Company address book configuration settings. | | `credit` - [`CompanyCredit!`](#companycredit) | Company credit balances and limits. | @@ -1636,6 +1657,7 @@ Contains the output schema for a company. "available_shipping_methods": [ CompanyAvailableShippingMethod ], + "catalogViewContext": CatalogViewContext, "company_admin": Customer, "config": CompanyConfig, "credit": CompanyCredit, @@ -1644,12 +1666,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": "abc123", + "reseller_id": "xyz789", "role": CompanyRole, "roles": CompanyRoles, "sales_representative": CompanySalesRepresentative, @@ -1683,7 +1705,7 @@ Contains details about the access control list settings of a resource. { "children": [CompanyAclResource], "id": "4", - "sort_order": 123, + "sort_order": 987, "text": "xyz789" } ``` @@ -1724,26 +1746,26 @@ Contains details about the access control list settings of a resource. ```json { "address_type": "BILLING", - "city": "abc123", - "company": "xyz789", - "company_id": 4, + "city": "xyz789", + "company": "abc123", + "company_id": "4", "country_code": "AF", "custom_attributes": [AttributeValueInterface], "extension_attributes": [CustomerAddressAttribute], "fax": "xyz789", "firstname": "xyz789", - "id": "4", - "is_default": false, - "lastname": "xyz789", - "middlename": "abc123", + "id": 4, + "is_default": true, + "lastname": "abc123", + "middlename": "xyz789", "nickname": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, + "region_id": 987, "street": ["abc123"], - "suffix": "abc123", - "telephone": "xyz789", + "suffix": "xyz789", + "telephone": "abc123", "vat_id": "xyz789" } ``` @@ -1782,20 +1804,20 @@ Defines the input schema for creating a company address. ```json { "address_type": "BILLING", - "city": "xyz789", - "company": "abc123", + "city": "abc123", + "company": "xyz789", "country_code": "AF", "custom_attributes": [AttributeValueInput], - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", - "is_default": true, - "lastname": "abc123", + "is_default": false, + "lastname": "xyz789", "middlename": "abc123", - "nickname": "abc123", + "nickname": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", "telephone": "abc123", "vat_id": "xyz789" @@ -1856,18 +1878,18 @@ Defines the input schema for updating a company address. The address type cannot "country_code": "AF", "custom_attributes": [AttributeValueInput], "fax": "xyz789", - "firstname": "abc123", + "firstname": "xyz789", "is_default": true, "lastname": "xyz789", - "middlename": "xyz789", - "nickname": "xyz789", + "middlename": "abc123", + "nickname": "abc123", "postcode": "xyz789", "prefix": "abc123", "region": CustomerAddressRegionInput, "street": ["xyz789"], - "suffix": "abc123", - "telephone": "xyz789", - "vat_id": "abc123" + "suffix": "xyz789", + "telephone": "abc123", + "vat_id": "xyz789" } ``` @@ -1891,7 +1913,7 @@ Contains a paginated list of company addresses. { "items": [CompanyAddress], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -1918,10 +1940,10 @@ Defines the input schema for creating a company administrator. ```json { "custom_attributes": [AttributeValueInput], - "email": "abc123", + "email": "xyz789", "firstname": "abc123", - "gender": 123, - "job_title": "xyz789", + "gender": 987, + "job_title": "abc123", "lastname": "abc123", "telephone": "xyz789" } @@ -1945,7 +1967,7 @@ Describes a carrier-level shipping option available to the company. ```json { "code": "xyz789", - "title": "abc123" + "title": "xyz789" } ``` @@ -1970,8 +1992,8 @@ The minimal required information to identify and display the company. ```json { "id": 4, - "is_admin": true, - "legal_name": "abc123", + "is_admin": false, + "legal_name": "xyz789", "name": "xyz789", "status": "PENDING" } @@ -2023,10 +2045,10 @@ Defines the input schema for creating a new company. { "company_admin": CompanyAdminInput, "company_email": "abc123", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressCreateInput, "legal_name": "abc123", - "reseller_id": "abc123", + "reseller_id": "xyz789", "vat_tax_id": "abc123" } ``` @@ -2077,7 +2099,7 @@ Contains details about prior company credit operations. { "items": [CompanyCreditOperation], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2099,7 +2121,7 @@ Defines a filter for narrowing the results of a credit history search. ```json { - "custom_reference_number": "abc123", + "custom_reference_number": "xyz789", "operation_type": "ALLOCATION", "updated_by": "xyz789" } @@ -2128,7 +2150,7 @@ Contains details about a single company credit operation. { "amount": Money, "balance": CompanyCredit, - "custom_reference_number": "abc123", + "custom_reference_number": "xyz789", "date": "abc123", "type": "ALLOCATION", "updated_by": CompanyCreditOperationUser @@ -2172,7 +2194,7 @@ Defines the administrator or company user that submitted a company credit operat #### Example ```json -{"name": "xyz789", "type": "CUSTOMER"} +{"name": "abc123", "type": "CUSTOMER"} ``` @@ -2253,7 +2275,7 @@ The result of accepting the company invitation. #### Example ```json -{"success": false} +{"success": true} ``` @@ -2276,11 +2298,11 @@ Company user attributes in the invitation. ```json { - "company_id": 4, - "customer_id": 4, + "company_id": "4", + "customer_id": "4", "job_title": "xyz789", "status": "ACTIVE", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -2307,10 +2329,10 @@ Contains details about the address where the company is registered to conduct bu { "city": "xyz789", "country_code": "AF", - "postcode": "abc123", + "postcode": "xyz789", "region": CustomerAddressRegion, - "street": ["abc123"], - "telephone": "abc123" + "street": ["xyz789"], + "telephone": "xyz789" } ``` @@ -2335,11 +2357,11 @@ Defines the input schema for defining a company's legal address. ```json { - "city": "xyz789", + "city": "abc123", "country_id": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput, - "street": ["xyz789"], + "street": ["abc123"], "telephone": "xyz789" } ``` @@ -2369,8 +2391,8 @@ Defines the input schema for updating a company's legal address. "country_id": "AF", "postcode": "xyz789", "region": CustomerAddressRegionInput, - "street": ["xyz789"], - "telephone": "abc123" + "street": ["abc123"], + "telephone": "xyz789" } ``` @@ -2393,7 +2415,7 @@ Contails details about a single role. ```json { - "id": "4", + "id": 4, "name": "abc123", "permissions": [CompanyAclResource], "users_count": 123 @@ -2417,8 +2439,8 @@ Defines the input schema for creating a company role. ```json { - "name": "abc123", - "permissions": ["abc123"] + "name": "xyz789", + "permissions": ["xyz789"] } ``` @@ -2440,9 +2462,9 @@ Defines the input schema for updating a company role. ```json { - "id": "4", - "name": "abc123", - "permissions": ["abc123"] + "id": 4, + "name": "xyz789", + "permissions": ["xyz789"] } ``` @@ -2466,7 +2488,7 @@ Contains an array of roles. { "items": [CompanyRole], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -2488,9 +2510,9 @@ Contains details about a company sales representative. ```json { - "email": "abc123", + "email": "xyz789", "firstname": "xyz789", - "lastname": "abc123" + "lastname": "xyz789" } ``` @@ -2567,7 +2589,11 @@ Defines an individual node in the company structure. #### Example ```json -{"entity": CompanyTeam, "id": 4, "parent_id": 4} +{ + "entity": CompanyTeam, + "id": 4, + "parent_id": "4" +} ``` @@ -2586,7 +2612,10 @@ 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" +} ``` @@ -2609,9 +2638,9 @@ Describes a company team. ```json { "description": "abc123", - "id": 4, - "name": "xyz789", - "structure_id": 4 + "id": "4", + "name": "abc123", + "structure_id": "4" } ``` @@ -2658,8 +2687,8 @@ Defines the input schema for updating a company team. ```json { "description": "abc123", - "id": "4", - "name": "xyz789" + "id": 4, + "name": "abc123" } ``` @@ -2685,10 +2714,10 @@ Defines the input schema for updating a company. ```json { "company_email": "xyz789", - "company_name": "abc123", + "company_name": "xyz789", "legal_address": CompanyLegalAddressUpdateInput, "legal_name": "abc123", - "reseller_id": "abc123", + "reseller_id": "xyz789", "vat_tax_id": "abc123" } ``` @@ -2717,13 +2746,13 @@ Defines the input schema for creating a company user. ```json { "email": "xyz789", - "firstname": "abc123", - "job_title": "xyz789", + "firstname": "xyz789", + "job_title": "abc123", "lastname": "xyz789", - "role_id": "4", + "role_id": 4, "status": "ACTIVE", - "target_id": 4, - "telephone": "xyz789" + "target_id": "4", + "telephone": "abc123" } ``` @@ -2769,10 +2798,10 @@ Defines the input schema for updating a company user. ```json { - "email": "xyz789", - "firstname": "abc123", + "email": "abc123", + "firstname": "xyz789", "id": 4, - "job_title": "xyz789", + "job_title": "abc123", "lastname": "xyz789", "role_id": "4", "status": "ACTIVE", @@ -2800,7 +2829,7 @@ Contains details about company users. { "items": [Customer], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2839,7 +2868,7 @@ Contains an attribute code that is used for product comparisons. ```json { - "code": "abc123", + "code": "xyz789", "label": "xyz789" } ``` @@ -2890,7 +2919,7 @@ Contains iterable information such as the array of items, the count, and attribu "attributes": [ComparableAttribute], "item_count": 987, "items": [ComparableItem], - "uid": "4" + "uid": 4 } ``` @@ -2934,6 +2963,7 @@ Represents all product types, except simple products. Complex product prices are | `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | | `images` - [`[ProductViewImage]`](/reference/graphql/saas/types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image` or `swatch`. | | `videos` - [`[ProductViewVideo]`](/reference/graphql/saas/types-k-p.md#productviewvideo) | A list of videos defined for the product. | +| `gallery` - [`[ProductViewMedia]`](/reference/graphql/saas/types-k-p.md#productviewmedia) | A list of all images and videos defined for the product, ordered as a single media gallery. | | `lastModifiedAt` - [`DateTime`](#datetime) | Date and time when the product was last updated. | | `metaDescription` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings. | | `metaKeyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | @@ -2958,28 +2988,29 @@ Represents all product types, except simple products. Complex product prices are { "addToCartAllowed": false, "inStock": false, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "xyz789", "id": "4", "images": [ProductViewImage], "videos": [ProductViewVideo], + "gallery": [ProductViewImage], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "abc123", - "name": "abc123", + "metaDescription": "abc123", + "metaKeyword": "abc123", + "metaTitle": "xyz789", + "name": "xyz789", "inputOptions": [ProductViewInputOption], "options": [ProductViewOption], "priceRange": ProductViewPriceRange, "shortDescription": "abc123", "sku": "xyz789", - "externalId": "abc123", + "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", + "url": "abc123", "urlKey": "xyz789", "links": [ProductViewLink], - "queryType": "abc123", + "queryType": "xyz789", "visibility": "abc123" } ``` @@ -3042,8 +3073,8 @@ Contains details about a configurable product attribute option. ```json { "code": "abc123", - "label": "abc123", - "uid": 4, + "label": "xyz789", + "uid": "4", "value_index": 987 } ``` @@ -3088,7 +3119,7 @@ An implementation for configurable product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "custom_attributes": [CustomAttribute], @@ -3097,11 +3128,11 @@ An implementation for configurable product cart items. "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, - "is_free_gift": false, + "is_available": true, + "is_free_gift": true, "is_salable": true, - "max_qty": 123.45, - "min_qty": 123.45, + "max_qty": 987.65, + "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "xyz789", @@ -3109,8 +3140,8 @@ An implementation for configurable product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": "4" + "quantity": 987.65, + "uid": 4 } ``` @@ -3131,8 +3162,8 @@ Describes configurable options that have been selected and can be selected as a ```json { - "attribute_code": "abc123", - "option_value_uids": ["4"] + "attribute_code": "xyz789", + "option_value_uids": [4] } ``` @@ -3176,29 +3207,29 @@ Describes configurable options that have been selected and can be selected as a { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], - "free_gift_label": "xyz789", + "free_gift_label": "abc123", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", - "parent_sku": "xyz789", + "id": 4, + "parent_sku": "abc123", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "xyz789", + "product_sku": "abc123", "product_type": "xyz789", "product_url_key": "abc123", "quantity_canceled": 987.65, - "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_invoiced": 987.65, + "quantity_ordered": 987.65, "quantity_refunded": 987.65, - "quantity_return_requested": 987.65, + "quantity_return_requested": 123.45, "quantity_returned": 987.65, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -3268,47 +3299,47 @@ Defines basic features of a configurable product and its simple product variants "categories": [CategoryInterface], "configurable_options": [ConfigurableProductOptions], "configurable_product_options_selection": ConfigurableProductOptionsSelection, - "country_of_manufacture": "xyz789", + "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "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", "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", - "new_from_date": "xyz789", + "name": "xyz789", + "new_from_date": "abc123", "new_to_date": "xyz789", - "only_x_left_in_stock": 987.65, + "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], "quantity": 123.45, - "rating_summary": 123.45, + "rating_summary": 987.65, "related_products": [ProductInterface], - "review_count": 123, + "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "variants": [ConfigurableVariant], "weight": 987.65 } @@ -3335,7 +3366,7 @@ Contains details about configurable product options. { "attribute_code": "abc123", "label": "xyz789", - "uid": 4, + "uid": "4", "values": [ConfigurableProductOptionValue] } ``` @@ -3360,9 +3391,9 @@ Defines a value for a configurable product option. ```json { - "is_available": false, + "is_available": true, "is_use_default": true, - "label": "xyz789", + "label": "abc123", "swatch": SwatchDataInterface, "uid": 4 } @@ -3393,7 +3424,7 @@ Defines configurable attributes for the specified product. "attribute_code": "xyz789", "attribute_uid": 4, "label": "xyz789", - "position": 987, + "position": 123, "uid": 4, "use_default": true, "values": [ConfigurableProductOptionsValues] @@ -3449,12 +3480,12 @@ Contains the index number assigned to a configurable product option. ```json { - "default_label": "abc123", + "default_label": "xyz789", "label": "abc123", "store_label": "abc123", "swatch_data": SwatchDataInterface, - "uid": 4, - "use_default_value": false + "uid": "4", + "use_default_value": true } ``` @@ -3484,7 +3515,7 @@ Contains details about configurable products added to a requisition list. "product": ProductInterface, "quantity": 987.65, "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -3533,14 +3564,14 @@ A configurable product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "configurable_options": [SelectedConfigurableOption], "configured_variant": ProductInterface, "customizable_options": [SelectedCustomizableOption], "description": "abc123", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3581,7 +3612,7 @@ Contains details about a customer email address to confirm. ```json { - "confirmation_key": "abc123", + "confirmation_key": "xyz789", "email": "xyz789" } ``` @@ -3602,7 +3633,7 @@ Contains details about a customer email address to confirm. ```json { "confirmation_key": "xyz789", - "order_id": "4" + "order_id": 4 } ``` @@ -3645,7 +3676,7 @@ List of account confirmation statuses. "comment": "xyz789", "email": "abc123", "name": "xyz789", - "telephone": "xyz789" + "telephone": "abc123" } ``` @@ -3664,7 +3695,7 @@ Contains the status of the request. #### Example ```json -{"status": true} +{"status": false} ``` @@ -3682,7 +3713,7 @@ An input object that defines the items in a requisition list to be copied. #### Example ```json -{"requisitionListItemUids": [4]} +{"requisitionListItemUids": ["4"]} ``` @@ -3751,7 +3782,7 @@ Contains the source and target wish lists after copying products. "full_name_locale": "xyz789", "id": "abc123", "three_letter_abbreviation": "abc123", - "two_letter_abbreviation": "xyz789" + "two_letter_abbreviation": "abc123" } ``` @@ -4104,7 +4135,7 @@ Contains an array of product IDs to use for creating a compare list. #### Example ```json -{"products": [4]} +{"products": ["4"]} ``` @@ -4133,9 +4164,9 @@ Defines a new gift registry. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "event_name": "abc123", + "event_name": "xyz789", "gift_registry_type_uid": "4", - "message": "xyz789", + "message": "abc123", "privacy_settings": "PRIVATE", "registrants": [AddGiftRegistryRegistrantInput], "shipping_address": GiftRegistryShippingAddressInput, @@ -4174,7 +4205,7 @@ Contains the results of a request to create a gift registry. #### Example ```json -{"cart_uid": 4} +{"cart_uid": "4"} ``` @@ -4237,11 +4268,11 @@ Contains payment order details that are used while processing the payment order ```json { - "cartId": "xyz789", + "cartId": "abc123", "location": "PRODUCT_DETAIL", "methodCode": "abc123", - "paymentSource": "xyz789", - "vaultIntent": false + "paymentSource": "abc123", + "vaultIntent": true } ``` @@ -4266,7 +4297,7 @@ Contains payment order details that are used while processing the payment order ```json { "amount": 123.45, - "currency_code": "xyz789", + "currency_code": "abc123", "id": "xyz789", "mp_order_id": "xyz789", "status": "abc123" @@ -4296,8 +4327,8 @@ Defines a new product review. "nickname": "abc123", "ratings": [ProductReviewRatingInput], "sku": "abc123", - "summary": "abc123", - "text": "abc123" + "summary": "xyz789", + "text": "xyz789" } ``` @@ -4382,8 +4413,8 @@ An input object that identifies and describes a new requisition list. ```json { - "description": "abc123", - "is_public": false, + "description": "xyz789", + "is_public": true, "name": "xyz789" } ``` @@ -4424,7 +4455,7 @@ Describe the variables needed to create a vault payment token ```json { "card_description": "abc123", - "setup_token_id": "abc123" + "setup_token_id": "xyz789" } ``` @@ -4446,7 +4477,7 @@ The vault token id and information about the payment source ```json { "payment_source": PaymentSourceOutput, - "vault_token_id": "abc123" + "vault_token_id": "xyz789" } ``` @@ -4487,7 +4518,7 @@ The setup token id information #### Example ```json -{"setup_token": "xyz789"} +{"setup_token": "abc123"} ``` @@ -4506,7 +4537,7 @@ Defines the name and visibility of a new wish list. #### Example ```json -{"name": "abc123", "visibility": "PUBLIC"} +{"name": "xyz789", "visibility": "PUBLIC"} ``` @@ -4550,7 +4581,7 @@ Contains credit memo details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": 4, + "id": "4", "items": [CreditMemoItemInterface], "number": "xyz789", "total": CreditMemoTotal @@ -4574,7 +4605,7 @@ Defines a credit memo item's custom attributes. ```json { - "credit_memo_id": "abc123", + "credit_memo_id": "xyz789", "custom_attributes": [CustomAttributeInput] } ``` @@ -4629,8 +4660,8 @@ Defines a credit memo's custom attributes. ```json { - "credit_memo_id": "abc123", - "credit_memo_item_id": "xyz789", + "credit_memo_id": "xyz789", + "credit_memo_item_id": "abc123", "custom_attributes": [CustomAttributeInput] } ``` @@ -4673,8 +4704,8 @@ Credit memo item details. "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` @@ -4751,10 +4782,10 @@ Contains credit memo price details. ```json { - "available_currency_codes": ["xyz789"], - "base_currency_code": "abc123", - "base_currency_symbol": "xyz789", - "default_display_currency_code": "abc123", + "available_currency_codes": ["abc123"], + "base_currency_code": "xyz789", + "base_currency_symbol": "abc123", + "default_display_currency_code": "xyz789", "default_display_currency_symbol": "abc123", "exchange_rates": [ExchangeRate] } @@ -4962,7 +4993,7 @@ Attributes of the product currently being viewed on PDP #### Example ```json -{"sku": "xyz789", "price": 123.45} +{"sku": "abc123", "price": 987.65} ``` @@ -5005,7 +5036,7 @@ Defines a custom attribute. ```json { "attribute_code": "abc123", - "value": "abc123" + "value": "xyz789" } ``` @@ -5048,8 +5079,8 @@ An interface containing fields that define the EAV attribute. "frontend_class": "abc123", "frontend_input": "BOOLEAN", "is_required": true, - "is_unique": true, - "label": "xyz789", + "is_unique": false, + "label": "abc123", "options": [CustomAttributeOptionInterface] } ``` @@ -5076,8 +5107,8 @@ An interface containing fields that define the EAV attribute. ```json { - "is_default": false, - "label": "xyz789", + "is_default": true, + "label": "abc123", "value": "xyz789" } ``` @@ -5120,7 +5151,7 @@ A simple key value object. ```json { "type": "UNKNOWN_CUSTOMOPERATOR_TYPE", - "value": ["abc123"] + "value": ["xyz789"] } ``` @@ -5155,6 +5186,7 @@ Defines the customer name, addresses, and other details. | `addressesV2` - [`CustomerAddresses`](#customeraddresses) | An array containing the customer's shipping and billing addresses. | | `admin_assistance_actions` - [`AdminAssistanceActions!`](/reference/graphql/saas/types-a-b.md#adminassistanceactions) | Actions performed by an admin on behalf of the customer (Login as Customer logging). | | `allow_remote_shopping_assistance` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Indicates whether the customer has enabled remote shopping assistance. | +| `chain_totals` - [`OrderChainTotal`](/reference/graphql/saas/types-k-p.md#orderchaintotal) | Aggregated sales totals across every order in the order-edit chain identified by the `original_number` filter. Requires the `original_number.eq` filter; the `in` condition is not supported here. Returns null if the chain doesn't exist, is empty, or doesn't belong to the current customer. | | `companies` - [`UserCompaniesOutput!`](/reference/graphql/saas/types-t-z.md#usercompaniesoutput) | An object that contains a list of companies user is assigned to. | | `company_hierarchy` - [`[CompanyHierarchy]`](#companyhierarchy) | The company relation hierarchies for all companies. Only available to the company administrator. | | `compare_list` - [`CompareList`](#comparelist) | The contents of the customer's compare list. | @@ -5209,6 +5241,7 @@ Defines the customer name, addresses, and other details. "addressesV2": CustomerAddresses, "admin_assistance_actions": AdminAssistanceActions, "allow_remote_shopping_assistance": false, + "chain_totals": OrderChainTotal, "companies": UserCompaniesOutput, "company_hierarchy": [CompanyHierarchy], "compare_list": CompareList, @@ -5216,19 +5249,19 @@ Defines the customer name, addresses, and other details. "created_at": "abc123", "custom_attributes": [AttributeValueInterface], "date_of_birth": "xyz789", - "default_billing": "xyz789", + "default_billing": "abc123", "default_shipping": "xyz789", "email": "abc123", - "firstname": "xyz789", - "gender": 123, + "firstname": "abc123", + "gender": 987, "gift_registries": [GiftRegistry], "gift_registry": GiftRegistry, "group": CustomerGroupStorefront, "id": "4", - "is_subscribed": true, - "job_title": "abc123", - "lastname": "abc123", - "middlename": "xyz789", + "is_subscribed": false, + "job_title": "xyz789", + "lastname": "xyz789", + "middlename": "abc123", "orders": CustomerOrders, "prefix": "abc123", "purchase_order": PurchaseOrder, @@ -5237,7 +5270,7 @@ Defines the customer name, addresses, and other details. "purchase_order_approval_rules": PurchaseOrderApprovalRules, "purchase_orders": PurchaseOrders, "purchase_orders_enabled": false, - "quote_enabled": false, + "quote_enabled": true, "requisition_lists": RequisitionLists, "return": Return, "returns": Returns, @@ -5247,9 +5280,9 @@ 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", + "taxvat": "xyz789", "team": CompanyTeam, "telephone": "xyz789", "wishlist_v2": Wishlist, @@ -5302,15 +5335,15 @@ Contains detailed information about a customer's billing or shipping address. "extension_attributes": [CustomerAddressAttribute], "fax": "abc123", "firstname": "xyz789", - "id": 123, + "id": 987, "lastname": "xyz789", - "middlename": "abc123", - "postcode": "abc123", + "middlename": "xyz789", + "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegion, - "region_id": 123, - "street": ["abc123"], - "suffix": "xyz789", + "region_id": 987, + "street": ["xyz789"], + "suffix": "abc123", "telephone": "abc123", "uid": 4, "vat_id": "abc123" @@ -5334,7 +5367,7 @@ Specifies the attribute code and value of a customer address attribute. ```json { - "attribute_code": "abc123", + "attribute_code": "xyz789", "value": "abc123" } ``` @@ -5371,23 +5404,23 @@ Contains details about a billing or shipping address. ```json { - "city": "abc123", - "company": "abc123", + "city": "xyz789", + "company": "xyz789", "country_code": "AF", "custom_attributesV2": [AttributeValueInput], - "default_billing": true, + "default_billing": false, "default_shipping": true, "fax": "abc123", - "firstname": "abc123", - "lastname": "abc123", + "firstname": "xyz789", + "lastname": "xyz789", "middlename": "xyz789", "postcode": "xyz789", "prefix": "xyz789", "region": CustomerAddressRegionInput, - "street": ["abc123"], - "suffix": "xyz789", - "telephone": "xyz789", - "vat_id": "xyz789" + "street": ["xyz789"], + "suffix": "abc123", + "telephone": "abc123", + "vat_id": "abc123" } ``` @@ -5409,9 +5442,9 @@ Defines the customer's state or province. ```json { - "region": "xyz789", + "region": "abc123", "region_code": "abc123", - "region_id": 123 + "region_id": 987 } ``` @@ -5433,9 +5466,9 @@ Defines the customer's state or province. ```json { - "region": "abc123", - "region_code": "xyz789", - "region_id": 987 + "region": "xyz789", + "region_code": "abc123", + "region_id": 123 } ``` @@ -5457,7 +5490,7 @@ Defines the customer's state or province. { "items": [CustomerAddress], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5489,16 +5522,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": false, - "is_unique": true, - "label": "xyz789", - "multiline_count": 123, + "is_unique": false, + "label": "abc123", + "multiline_count": 987, "options": [CustomAttributeOptionInterface], "sort_order": 123, "validate_rules": [ValidationRule] @@ -5507,6 +5540,24 @@ Customer attribute metadata. +### CustomerChainTotalsFilterInput + +Filter input for customer chain totals. + +#### Input Fields + +| Input Field | Description | +|-------------|-------------| +| `original_number` - [`FilterEqualTypeInput!`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter by any order number in an order-edit chain (the original order or one of its edited children) to return the full chain totals. | + +#### Example + +```json +{"original_number": FilterEqualTypeInput} +``` + + + ### CustomerCreateInput An input object for creating a customer. @@ -5535,15 +5586,15 @@ An input object for creating a customer. { "allow_remote_shopping_assistance": true, "custom_attributes": [AttributeValueInput], - "date_of_birth": "abc123", - "email": "abc123", + "date_of_birth": "xyz789", + "email": "xyz789", "firstname": "xyz789", - "gender": 123, + "gender": 987, "is_subscribed": true, - "lastname": "abc123", + "lastname": "xyz789", "middlename": "xyz789", - "password": "xyz789", - "prefix": "xyz789", + "password": "abc123", + "prefix": "abc123", "suffix": "abc123", "taxvat": "abc123" } @@ -5561,6 +5612,9 @@ Contains details about a single downloadable product. |------------|-------------| | `date` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The date and time the purchase was made. | | `download_url` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The fully qualified URL to the download file. | +| `file_extension` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The extension of the downloadable file, in lower case and without the leading dot. Null if unknown. | +| `file_name` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The name of the downloadable file, including its extension. Null if unknown. | +| `mime_type` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The MIME type of the downloadable file, such as `audio/mpeg` or `application/pdf`. Null if unknown. | | `order_increment_id` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The unique ID assigned to the item. | | `remaining_downloads` - [`String`](/reference/graphql/saas/types-q-s.md#string) | The remaining number of times the customer can download the product. | | `status` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Indicates when the product becomes available for download. Options are `Pending` and `Invoiced`. | @@ -5569,11 +5623,14 @@ Contains details about a single downloadable product. ```json { - "date": "abc123", - "download_url": "xyz789", + "date": "xyz789", + "download_url": "abc123", + "file_extension": "xyz789", + "file_name": "xyz789", + "mime_type": "abc123", "order_increment_id": "abc123", "remaining_downloads": "abc123", - "status": "abc123" + "status": "xyz789" } ``` @@ -5670,26 +5727,26 @@ Contains details about each of the customer's orders. "credit_memos": [CreditMemo], "custom_attributes": [CustomAttribute], "customer_info": OrderCustomerInfo, - "email": "xyz789", + "email": "abc123", "gift_message": GiftMessage, "gift_receipt_included": true, "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_status_change_date": "xyz789", + "order_date": "abc123", + "order_status_change_date": "abc123", "payment_methods": [OrderPaymentMethod], "printed_card_included": true, "returns": Returns, "shipments": [OrderShipment], "shipping_address": OrderAddress, "shipping_method": "xyz789", - "status": "abc123", + "status": "xyz789", "token": "xyz789", "total": OrderTotal } @@ -5752,10 +5809,10 @@ The collection of orders that match the conditions defined in the filter. ```json { - "date_of_first_order": "abc123", + "date_of_first_order": "xyz789", "items": [CustomerOrder], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -5772,6 +5829,7 @@ Identifies the filter to use for filtering orders. | `grand_total` - [`FilterRangeTypeInput`](/reference/graphql/saas/types-f-i.md#filterrangetypeinput) | Filters by order base grand total value. | | `number` - [`FilterStringTypeInput`](/reference/graphql/saas/types-f-i.md#filterstringtypeinput) | Filters by order number. | | `order_date` - [`FilterRangeTypeInput`](/reference/graphql/saas/types-f-i.md#filterrangetypeinput) | Filters by order created_at time. | +| `original_number` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filter by any order number in an order-edit chain (the original order or one of its edited children) to return the full chain. | | `search` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Searches orders by order number, product name, or SKU. | | `status` - [`FilterEqualTypeInput`](/reference/graphql/saas/types-f-i.md#filterequaltypeinput) | Filters by order status. | @@ -5782,7 +5840,8 @@ Identifies the filter to use for filtering orders. "grand_total": FilterRangeTypeInput, "number": FilterStringTypeInput, "order_date": FilterRangeTypeInput, - "search": "xyz789", + "original_number": FilterEqualTypeInput, + "search": "abc123", "status": FilterEqualTypeInput } ``` @@ -5959,17 +6018,17 @@ An input object for updating a customer. ```json { - "allow_remote_shopping_assistance": true, + "allow_remote_shopping_assistance": false, "custom_attributes": [AttributeValueInput], "date_of_birth": "xyz789", - "firstname": "abc123", - "gender": 987, + "firstname": "xyz789", + "gender": 123, "is_subscribed": true, "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "xyz789", + "middlename": "abc123", + "prefix": "abc123", "suffix": "abc123", - "taxvat": "xyz789" + "taxvat": "abc123" } ``` @@ -5994,10 +6053,10 @@ Contains information about a text area that is defined as part of a customizable ```json { - "product_sku": "xyz789", - "required": false, - "sort_order": 123, - "title": "xyz789", + "product_sku": "abc123", + "required": true, + "sort_order": 987, + "title": "abc123", "uid": "4", "value": CustomizableAreaValue } @@ -6024,7 +6083,7 @@ Defines the price and sku of a product whose page contains a customized text are ```json { "max_characters": 123, - "price": 987.65, + "price": 123.45, "price_type": "FIXED", "sku": "abc123", "uid": "4" @@ -6051,10 +6110,10 @@ Contains information about a set of checkbox values that are defined as part of ```json { - "required": false, + "required": true, "sort_order": 123, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableCheckboxValue] } ``` @@ -6081,13 +6140,13 @@ Defines the price and sku of a product whose page contains a customized set of c ```json { - "option_type_id": 987, + "option_type_id": 123, "price": 987.65, "price_type": "FIXED", "sku": "xyz789", - "sort_order": 123, + "sort_order": 987, "title": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -6113,9 +6172,9 @@ Contains information about a date picker that is defined as part of a customizab ```json { "product_sku": "abc123", - "required": true, + "required": false, "sort_order": 987, - "title": "xyz789", + "title": "abc123", "uid": 4, "value": CustomizableDateValue } @@ -6165,7 +6224,7 @@ Defines the price and sku of a product whose page contains a customized date pic "price_type": "FIXED", "sku": "xyz789", "type": "DATE", - "uid": 4 + "uid": "4" } ``` @@ -6189,10 +6248,10 @@ Contains information about a drop down menu that is defined as part of a customi ```json { - "required": true, - "sort_order": 123, + "required": false, + "sort_order": 987, "title": "xyz789", - "uid": 4, + "uid": "4", "value": [CustomizableDropDownValue] } ``` @@ -6220,9 +6279,9 @@ Defines the price and sku of a product whose page contains a customized drop dow ```json { "option_type_id": 123, - "price": 123.45, + "price": 987.65, "price_type": "FIXED", - "sku": "xyz789", + "sku": "abc123", "sort_order": 987, "title": "xyz789", "uid": "4" @@ -6251,10 +6310,10 @@ Contains information about a text field that is defined as part of a customizabl ```json { "product_sku": "xyz789", - "required": true, - "sort_order": 987, + "required": false, + "sort_order": 123, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableFieldValue } ``` @@ -6279,7 +6338,7 @@ Defines the price and sku of a product whose page contains a customized text fie ```json { - "max_characters": 123, + "max_characters": 987, "price": 123.45, "price_type": "FIXED", "sku": "xyz789", @@ -6308,11 +6367,11 @@ Contains information about a file picker that is defined as part of a customizab ```json { - "product_sku": "xyz789", - "required": false, - "sort_order": 123, + "product_sku": "abc123", + "required": true, + "sort_order": 987, "title": "xyz789", - "uid": 4, + "uid": "4", "value": CustomizableFileValue } ``` @@ -6341,11 +6400,11 @@ Defines the price and sku of a product whose page contains a customized file pic { "file_extension": "xyz789", "image_size_x": 123, - "image_size_y": 123, - "price": 123.45, + "image_size_y": 987, + "price": 987.65, "price_type": "FIXED", "sku": "abc123", - "uid": 4 + "uid": "4" } ``` @@ -6399,10 +6458,10 @@ Defines the price and sku of a product whose page contains a customized multisel ```json { - "option_type_id": 123, - "price": 123.45, + "option_type_id": 987, + "price": 987.65, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 987, "title": "xyz789", "uid": "4" @@ -6425,7 +6484,10 @@ Defines a customizable option. #### Example ```json -{"uid": 4, "value_string": "xyz789"} +{ + "uid": "4", + "value_string": "xyz789" +} ``` @@ -6462,7 +6524,7 @@ Contains basic information about a customizable option. It can be implemented by { "required": false, "sort_order": 123, - "title": "xyz789", + "title": "abc123", "uid": "4" } ``` @@ -6517,9 +6579,9 @@ Contains information about a set of radio buttons that are defined as part of a ```json { "required": true, - "sort_order": 987, + "sort_order": 123, "title": "abc123", - "uid": "4", + "uid": 4, "value": [CustomizableRadioValue] } ``` @@ -6546,13 +6608,13 @@ Defines the price and sku of a product whose page contains a customized set of r ```json { - "option_type_id": 123, - "price": 987.65, + "option_type_id": 987, + "price": 123.45, "price_type": "FIXED", - "sku": "abc123", + "sku": "xyz789", "sort_order": 123, "title": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -6601,7 +6663,7 @@ Contains the status of the request to delete a company team. #### Example ```json -{"success": false} +{"success": true} ``` @@ -6728,7 +6790,7 @@ Specifies the quote template id of the quote template to delete #### Example ```json -{"quote_uids": ["4"]} +{"quote_uids": [4]} ``` @@ -6775,7 +6837,7 @@ Indicates whether the request succeeded and returns the remaining customer payme ```json { "customerPaymentTokens": CustomerPaymentTokens, - "result": true + "result": false } ``` @@ -6795,7 +6857,7 @@ Contains details about an error that occurred when deleting an approval rule . #### Example ```json -{"message": "abc123", "type": "UNDEFINED"} +{"message": "xyz789", "type": "UNDEFINED"} ``` @@ -6830,7 +6892,7 @@ Specifies the IDs of the approval rules to delete. #### Example ```json -{"approval_rule_uids": ["4"]} +{"approval_rule_uids": [4]} ``` @@ -6904,7 +6966,7 @@ Contains the status of the request to delete a wish list and an array of the cus #### Example ```json -{"status": false, "wishlists": [Wishlist]} +{"status": true, "wishlists": [Wishlist]} ``` @@ -6932,10 +6994,10 @@ Specifies the discount type and value for quote line item. "amount": Money, "applied_to": "ITEM", "coupon": AppliedCoupon, - "is_discounting_locked": false, - "label": "xyz789", - "type": "xyz789", - "value": 123.45 + "is_discounting_locked": true, + "label": "abc123", + "type": "abc123", + "value": 987.65 } ``` @@ -6982,9 +7044,9 @@ An implementation for downloadable product cart items. "errors": [CartItemError], "is_available": true, "is_free_gift": true, - "is_salable": false, + "is_salable": true, "links": [DownloadableProductLinks], - "max_qty": 123.45, + "max_qty": 987.65, "min_qty": 987.65, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], @@ -6995,7 +7057,7 @@ An implementation for downloadable product cart items. "product": ProductInterface, "quantity": 987.65, "samples": [DownloadableProductSamples], - "uid": 4 + "uid": "4" } ``` @@ -7026,9 +7088,9 @@ 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_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", "quantity_refunded": 123.45 @@ -7067,7 +7129,7 @@ Defines downloadable product options for `InvoiceItemInterface`. "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 123.45 + "quantity_invoiced": 987.65 } ``` @@ -7091,7 +7153,7 @@ Defines characteristics of the links for downloadable product. { "sort_order": 123, "title": "abc123", - "uid": "4" + "uid": 4 } ``` @@ -7143,23 +7205,23 @@ Defines downloadable product options for `OrderItemInterface`. "free_gift_label": "abc123", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "abc123", - "product_url_key": "abc123", + "product_type": "xyz789", + "product_url_key": "xyz789", "quantity_canceled": 987.65, "quantity_invoiced": 123.45, - "quantity_ordered": 987.65, + "quantity_ordered": 123.45, "quantity_refunded": 987.65, "quantity_return_requested": 123.45, "quantity_returned": 123.45, - "quantity_shipped": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "abc123" + "status": "xyz789" } ``` @@ -7225,7 +7287,7 @@ Defines a product that the shopper downloads. ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], @@ -7238,21 +7300,21 @@ Defines a product that the shopper downloads. DownloadableProductSamples ], "gift_message_available": true, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "links_purchased_separately": 123, "links_title": "abc123", - "manufacturer": 987, - "max_sale_qty": 987.65, + "manufacturer": 123, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", "meta_keyword": "abc123", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, "name": "abc123", - "new_from_date": "abc123", + "new_from_date": "xyz789", "new_to_date": "xyz789", "only_x_left_in_stock": 987.65, "options": [CustomizableOptionInterface], @@ -7260,7 +7322,7 @@ Defines a product that the shopper downloads. "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, @@ -7273,9 +7335,9 @@ Defines a product that the shopper downloads. "stock_status": "IN_STOCK", "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -7326,9 +7388,9 @@ Defines characteristics of a downloadable product. ```json { "price": 987.65, - "sample_url": "abc123", - "sort_order": 987, - "title": "abc123", + "sample_url": "xyz789", + "sort_order": 123, + "title": "xyz789", "uid": 4 } ``` @@ -7370,8 +7432,8 @@ Defines characteristics of a downloadable product. ```json { "sample_url": "abc123", - "sort_order": 987, - "title": "xyz789" + "sort_order": 123, + "title": "abc123" } ``` @@ -7400,10 +7462,10 @@ Contains details about downloadable products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "links": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples], "sku": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -7432,11 +7494,11 @@ A downloadable product wish list item. { "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "links_v2": [DownloadableProductLinks], "product": ProductInterface, - "quantity": 987.65, + "quantity": 123.45, "samples": [DownloadableProductSamples] } ``` @@ -7457,7 +7519,10 @@ Identifies a quote to be duplicated #### Example ```json -{"duplicated_quote_uid": 4, "quote_uid": 4} +{ + "duplicated_quote_uid": 4, + "quote_uid": "4" +} ``` @@ -7496,7 +7561,7 @@ Contains details about a custom text attribute that the buyer entered. ```json { "attribute_code": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -7516,10 +7581,7 @@ Defines a customer-entered option. #### Example ```json -{ - "uid": "4", - "value": "xyz789" -} +{"uid": 4, "value": "abc123"} ``` @@ -7572,7 +7634,7 @@ An error encountered while adding an item to the the cart. #### Example ```json -{"message": "abc123"} +{"message": "xyz789"} ``` @@ -7594,7 +7656,7 @@ Contains details about an address. ```json { "country_code": "AF", - "postcode": "xyz789", + "postcode": "abc123", "region": CustomerAddressRegionInput } ``` @@ -7695,7 +7757,7 @@ Lists the exchange rate. #### Example ```json -{"currency_to": "xyz789", "rate": 987.65} +{"currency_to": "xyz789", "rate": 123.45} ``` 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 4ba63ce0e..cbc144543 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 @@ -20,7 +20,7 @@ ```json { "code": "xyz789", - "is_visible": true, + "is_visible": false, "payment_intent": "abc123", "payment_source": "abc123", "sdk_params": [SDKParams], @@ -47,8 +47,8 @@ Fastlane Payment inputs ```json { - "payment_source": "abc123", - "paypal_fastlane_token": "xyz789" + "payment_source": "xyz789", + "paypal_fastlane_token": "abc123" } ``` @@ -94,7 +94,7 @@ Defines a filter that matches the input exactly. ```json { "eq": "abc123", - "in": ["abc123"] + "in": ["xyz789"] } ``` @@ -151,7 +151,7 @@ Defines a filter that matches a range of values, such as prices or dates. ```json { - "from": "abc123", + "from": "xyz789", "to": "xyz789" } ``` @@ -214,8 +214,8 @@ Defines a filter for an input string. ```json { - "eq": "xyz789", - "in": ["abc123"], + "eq": "abc123", + "in": ["xyz789"], "match": "abc123" } ``` @@ -252,17 +252,17 @@ Defines the comparison operators that can be used in a filter. "eq": "abc123", "from": "xyz789", "gt": "xyz789", - "gteq": "abc123", + "gteq": "xyz789", "in": ["xyz789"], - "like": "abc123", + "like": "xyz789", "lt": "abc123", - "lteq": "xyz789", - "moreq": "abc123", - "neq": "xyz789", + "lteq": "abc123", + "moreq": "xyz789", + "neq": "abc123", "nin": ["xyz789"], - "notnull": "abc123", - "null": "xyz789", - "to": "abc123" + "notnull": "xyz789", + "null": "abc123", + "to": "xyz789" } ``` @@ -286,7 +286,7 @@ Contains product attributes that can be used for filtering in a `productSearch` ```json { "attribute": "xyz789", - "frontendInput": "abc123", + "frontendInput": "xyz789", "label": "xyz789", "numeric": false } @@ -310,7 +310,7 @@ A single FPT that can be applied to a product price. ```json { "amount": Money, - "label": "xyz789" + "label": "abc123" } ``` @@ -381,7 +381,7 @@ Contains the generated customer token. #### Example ```json -{"customer_token": "abc123"} +{"customer_token": "xyz789"} ``` @@ -417,7 +417,7 @@ Contains the generated negotiable quote id. #### Example ```json -{"negotiable_quote_uid": "4"} +{"negotiable_quote_uid": 4} ``` @@ -457,7 +457,7 @@ Contains details about the gift card account. ```json { "balance": Money, - "code": "abc123", + "code": "xyz789", "expiration_date": "xyz789" } ``` @@ -500,9 +500,9 @@ Contains the value of a gift card, the website that generated the card, and rela ```json { - "attribute_id": 987, - "uid": 4, - "value": 123.45, + "attribute_id": 123, + "uid": "4", + "value": 987.65, "website_id": 987, "website_value": 123.45 } @@ -553,29 +553,29 @@ Contains details about a gift card that has been added to a cart. { "amount": Money, "available_gift_wrapping": [GiftWrapping], - "backorder_message": "abc123", + "backorder_message": "xyz789", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "is_available": false, + "is_available": true, "is_free_gift": true, "is_salable": true, - "max_qty": 987.65, + "max_qty": 123.45, "message": "xyz789", - "min_qty": 987.65, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], - "not_available_message": "abc123", + "not_available_message": "xyz789", "note_from_buyer": [ItemNote], "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, "quantity": 987.65, - "recipient_email": "abc123", - "recipient_name": "abc123", + "recipient_email": "xyz789", + "recipient_name": "xyz789", "sender_email": "xyz789", "sender_name": "xyz789", "uid": 4 @@ -609,10 +609,10 @@ Contains details about a gift card that has been added to a cart. "gift_card": GiftCardItem, "id": 4, "order_item": OrderItemInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_refunded": 123.45 + "product_sku": "xyz789", + "quantity_refunded": 987.65 } ``` @@ -641,12 +641,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": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -672,9 +672,9 @@ Contains details about a gift card. { "message": "abc123", "recipient_email": "abc123", - "recipient_name": "abc123", + "recipient_name": "xyz789", "sender_email": "xyz789", - "sender_name": "abc123" + "sender_name": "xyz789" } ``` @@ -702,10 +702,10 @@ Contains details about the sender, recipient, and amount of a gift card. { "amount": Money, "custom_giftcard_amount": Money, - "message": "xyz789", - "recipient_email": "xyz789", + "message": "abc123", + "recipient_email": "abc123", "recipient_name": "abc123", - "sender_email": "abc123", + "sender_email": "xyz789", "sender_name": "abc123" } ``` @@ -750,29 +750,29 @@ Contains details about the sender, recipient, and amount of a gift card. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], - "free_gift_label": "abc123", + "free_gift_label": "xyz789", "gift_card": GiftCardItem, "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": 4, + "id": "4", "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "abc123", - "product_url_key": "xyz789", - "quantity_canceled": 987.65, - "quantity_invoiced": 987.65, - "quantity_ordered": 123.45, - "quantity_refunded": 987.65, + "product_type": "xyz789", + "product_url_key": "abc123", + "quantity_canceled": 123.45, + "quantity_invoiced": 123.45, + "quantity_ordered": 987.65, + "quantity_refunded": 123.45, "quantity_return_requested": 123.45, - "quantity_returned": 987.65, - "quantity_shipped": 123.45, + "quantity_returned": 123.45, + "quantity_shipped": 987.65, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -846,15 +846,15 @@ Defines properties of a gift card. ```json { "allow_message": true, - "allow_open_amount": true, - "canonical_url": "abc123", + "allow_open_amount": false, + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_card_options": [CustomizableOptionInterface], - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": false, "gift_wrapping_price": Money, "giftcard_amounts": [GiftCardAmounts], @@ -862,42 +862,42 @@ Defines properties of a gift card. "image": ProductImage, "is_redeemable": false, "is_returnable": "abc123", - "lifetime": 123, - "manufacturer": 987, - "max_sale_qty": 123.45, + "lifetime": 987, + "manufacturer": 123, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "message_max_length": 123, + "message_max_length": 987, "meta_description": "xyz789", - "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_keyword": "xyz789", + "meta_title": "xyz789", "min_sale_qty": 987.65, "name": "abc123", "new_from_date": "abc123", "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "open_amount_max": 987.65, + "only_x_left_in_stock": 123.45, + "open_amount_max": 123.45, "open_amount_min": 123.45, "options": [CustomizableOptionInterface], "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 987.65, - "rating_summary": 987.65, + "quantity": 123.45, + "rating_summary": 123.45, "related_products": [ProductInterface], "review_count": 123, "reviews": ProductReviews, "short_description": ComplexTextValue, "sku": "abc123", "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": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, - "uid": 4, + "uid": "4", "upsell_products": [ProductInterface], - "url_key": "abc123", + "url_key": "xyz789", "weight": 987.65 } ``` @@ -926,9 +926,9 @@ Contains details about gift cards added to a requisition list. "customizable_options": [SelectedCustomizableOption], "gift_card_options": GiftCardOptions, "product": ProductInterface, - "quantity": 123.45, - "sku": "xyz789", - "uid": "4" + "quantity": 987.65, + "sku": "abc123", + "uid": 4 } ``` @@ -953,12 +953,12 @@ Contains details about gift cards added to a requisition list. ```json { "gift_card": GiftCardItem, - "id": "4", + "id": 4, "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", - "quantity_shipped": 987.65 + "product_sku": "xyz789", + "quantity_shipped": 123.45 } ``` @@ -1008,9 +1008,9 @@ A single gift card added to a wish list. "customizable_options": [SelectedCustomizableOption], "description": "abc123", "gift_card_options": GiftCardOptions, - "id": 4, + "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1033,7 +1033,7 @@ Gift card custom attribute value containing array data. ```json { "attribute_type": "xyz789", - "code": 4, + "code": "4", "options": ["abc123"] } ``` @@ -1056,9 +1056,9 @@ Contains the text of a gift message, its sender, and recipient ```json { - "from": "abc123", + "from": "xyz789", "message": "abc123", - "to": "xyz789" + "to": "abc123" } ``` @@ -1081,7 +1081,7 @@ Defines a gift message. ```json { "from": "xyz789", - "message": "abc123", + "message": "xyz789", "to": "abc123" } ``` @@ -1145,7 +1145,7 @@ Contains details about a gift registry. { "created_at": "xyz789", "dynamic_attributes": [GiftRegistryDynamicAttribute], - "event_name": "xyz789", + "event_name": "abc123", "items": [GiftRegistryItemInterface], "message": "xyz789", "owner_name": "abc123", @@ -1178,7 +1178,7 @@ Contains details about a gift registry. "code": 4, "group": "EVENT_INFORMATION", "label": "xyz789", - "value": "xyz789" + "value": "abc123" } ``` @@ -1221,10 +1221,7 @@ Defines a dynamic attribute. #### Example ```json -{ - "code": "4", - "value": "xyz789" -} +{"code": 4, "value": "abc123"} ``` @@ -1275,11 +1272,11 @@ Defines a dynamic attribute. ```json { - "attribute_group": "abc123", - "code": 4, - "input_type": "abc123", - "is_required": true, - "label": "abc123", + "attribute_group": "xyz789", + "code": "4", + "input_type": "xyz789", + "is_required": false, + "label": "xyz789", "sort_order": 987 } ``` @@ -1309,11 +1306,11 @@ Defines a dynamic attribute. ```json { - "attribute_group": "xyz789", + "attribute_group": "abc123", "code": 4, "input_type": "xyz789", - "is_required": false, - "label": "xyz789", + "is_required": true, + "label": "abc123", "sort_order": 123 } ``` @@ -1337,12 +1334,12 @@ Defines a dynamic attribute. ```json { - "created_at": "xyz789", - "note": "xyz789", + "created_at": "abc123", + "note": "abc123", "product": ProductInterface, - "quantity": 123.45, + "quantity": 987.65, "quantity_fulfilled": 987.65, - "uid": 4 + "uid": "4" } ``` @@ -1372,7 +1369,7 @@ Defines a dynamic attribute. ```json { "created_at": "abc123", - "note": "abc123", + "note": "xyz789", "product": ProductInterface, "quantity": 987.65, "quantity_fulfilled": 987.65, @@ -1403,7 +1400,7 @@ Contains the status and any errors that encountered with the customer's gift reg ```json { - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -1432,7 +1429,7 @@ Contains details about an error that occurred when processing a gift registry it "gift_registry_item_uid": 4, "gift_registry_uid": 4, "message": "xyz789", - "product_uid": "4" + "product_uid": 4 } ``` @@ -1523,7 +1520,7 @@ Contains details about a registrant. GiftRegistryRegistrantDynamicAttribute ], "email": "abc123", - "firstname": "xyz789", + "firstname": "abc123", "lastname": "abc123", "uid": 4 } @@ -1545,8 +1542,8 @@ Contains details about a registrant. ```json { - "code": "4", - "label": "xyz789", + "code": 4, + "label": "abc123", "value": "abc123" } ``` @@ -1572,11 +1569,11 @@ Contains the results of a gift registry search. ```json { - "event_date": "xyz789", - "event_title": "abc123", - "gift_registry_uid": "4", + "event_date": "abc123", + "event_title": "xyz789", + "gift_registry_uid": 4, "location": "xyz789", - "name": "xyz789", + "name": "abc123", "type": "abc123" } ``` @@ -1601,7 +1598,7 @@ Defines a shipping address for a gift registry. Specify either `address_data` or { "address_data": CustomerAddressInput, "address_id": "4", - "customer_address_uid": "4" + "customer_address_uid": 4 } ``` @@ -1645,7 +1642,7 @@ Contains details about a gift registry type. "dynamic_attributes_metadata": [ GiftRegistryDynamicAttributeMetadataInterface ], - "label": "xyz789", + "label": "abc123", "uid": "4" } ``` @@ -1672,7 +1669,7 @@ Contains details about the selected or available gift wrapping options. "design": "xyz789", "image": GiftWrappingImage, "price": Money, - "uid": 4 + "uid": "4" } ``` @@ -1693,7 +1690,7 @@ Points to an image associated with a gift wrapping option. ```json { - "label": "abc123", + "label": "xyz789", "url": "abc123" } ``` @@ -1714,7 +1711,7 @@ Points to an image associated with a gift wrapping option. ```json { - "color": "abc123", + "color": "xyz789", "height": 123, "type": "abc123" } @@ -1744,11 +1741,11 @@ Points to an image associated with a gift wrapping option. ```json { "button_styles": GooglePayButtonStyles, - "code": "xyz789", + "code": "abc123", "google_pay_mode": "TEST", "is_visible": true, - "payment_intent": "xyz789", - "payment_source": "xyz789", + "payment_intent": "abc123", + "payment_source": "abc123", "sdk_params": [SDKParams], "sort_order": "xyz789", "three_ds_mode": "OFF", @@ -1774,7 +1771,7 @@ Google Pay inputs ```json { - "payment_source": "abc123", + "payment_source": "xyz789", "payments_order_id": "xyz789", "paypal_order_id": "xyz789" } @@ -1858,30 +1855,30 @@ Defines a grouped product, which consists of simple standalone products that are ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], "country_of_manufacture": "abc123", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": false, + "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "abc123", "items": [GroupedProductItem], - "manufacturer": 987, + "manufacturer": 123, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "xyz789", "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", + "name": "abc123", "new_from_date": "xyz789", - "new_to_date": "abc123", - "only_x_left_in_stock": 987.65, - "options_container": "xyz789", + "new_to_date": "xyz789", + "only_x_left_in_stock": 123.45, + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], @@ -1893,14 +1890,14 @@ Defines a grouped product, which consists of simple standalone products that are "short_description": ComplexTextValue, "sku": "abc123", "small_image": ProductImage, - "special_price": 123.45, + "special_price": 987.65, "special_to_date": "xyz789", "stock_status": "IN_STOCK", - "swatch_image": "xyz789", + "swatch_image": "abc123", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", + "url_key": "abc123", "weight": 987.65 } ``` @@ -1923,9 +1920,9 @@ Contains information about an individual grouped product item. ```json { - "position": 123, + "position": 987, "product": ProductInterface, - "qty": 123.45 + "qty": 987.65 } ``` @@ -1950,12 +1947,12 @@ A grouped product wish list item. ```json { - "added_at": "abc123", + "added_at": "xyz789", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", + "description": "xyz789", "id": "4", "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1977,7 +1974,7 @@ Input to retrieve a guest order based on token. ```json { "reason": "abc123", - "token": "xyz789" + "token": "abc123" } ``` @@ -1999,8 +1996,8 @@ Input to retrieve an order based on details. ```json { - "email": "abc123", - "lastname": "xyz789", + "email": "xyz789", + "lastname": "abc123", "number": "abc123" } ``` @@ -2024,8 +2021,8 @@ An object that provides highlighted text for matched words ```json { "attribute": "xyz789", - "matched_words": ["abc123"], - "value": "abc123" + "matched_words": ["xyz789"], + "value": "xyz789" } ``` @@ -2054,8 +2051,8 @@ Item note data that is added to the negotiable quote history object. "creator_name": "abc123", "creator_type": "abc123", "item_id": 987, - "note": "abc123", - "product_name": "xyz789" + "note": "xyz789", + "product_name": "abc123" } ``` @@ -2083,11 +2080,11 @@ Item note data that is added to the negotiable quote history object. ```json { - "cc_vault_code": "xyz789", - "code": "abc123", + "cc_vault_code": "abc123", + "code": "xyz789", "is_vault_enabled": true, "is_visible": false, - "payment_intent": "abc123", + "payment_intent": "xyz789", "payment_source": "xyz789", "requires_card_details": true, "sdk_params": [SDKParams], @@ -2123,12 +2120,12 @@ Hosted Fields payment inputs { "cardBin": "xyz789", "cardExpiryMonth": "abc123", - "cardExpiryYear": "abc123", - "cardLast4": "abc123", + "cardExpiryYear": "xyz789", + "cardLast4": "xyz789", "holderName": "abc123", - "is_active_payment_token_enabler": false, - "payment_source": "abc123", - "payments_order_id": "xyz789", + "is_active_payment_token_enabler": true, + "payment_source": "xyz789", + "payments_order_id": "abc123", "paypal_order_id": "xyz789" } ``` @@ -2142,7 +2139,7 @@ The `ID` scalar type represents a unique identifier, often used to refetch an ob #### Example ```json -"4" +4 ``` @@ -2227,7 +2224,7 @@ List of templates/filters applied to customer attribute input. { "code": "PRODUCT_NOT_FOUND", "message": "abc123", - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -2240,7 +2237,7 @@ The `Int` scalar type represents non-fractional signed whole numeric values. Int #### Example ```json -123 +987 ``` @@ -2284,7 +2281,7 @@ Contains invoice details. { "comments": [SalesCommentItem], "custom_attributes": [CustomAttribute], - "id": 4, + "id": "4", "items": [InvoiceItemInterface], "number": "abc123", "total": InvoiceTotal @@ -2309,7 +2306,7 @@ Defines an invoice custom attributes. ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789" + "invoice_id": "abc123" } ``` @@ -2338,9 +2335,9 @@ Defines an invoice custom attributes. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, - "product_sku": "abc123", + "product_sku": "xyz789", "quantity_invoiced": 987.65 } ``` @@ -2364,8 +2361,8 @@ Defines an invoice item custom attributes. ```json { "custom_attributes": [CustomAttributeInput], - "invoice_id": "xyz789", - "invoice_item_id": "abc123" + "invoice_id": "abc123", + "invoice_item_id": "xyz789" } ``` @@ -2405,10 +2402,10 @@ Contains detailes about invoiced items. "discounts": [Discount], "id": 4, "order_item": OrderItemInterface, - "product_name": "xyz789", + "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_invoiced": 987.65 + "quantity_invoiced": 123.45 } ``` @@ -2515,7 +2512,7 @@ Contains the response of a role name validation query. #### Example ```json -{"is_role_name_available": false} +{"is_role_name_available": true} ``` @@ -2533,7 +2530,7 @@ Contains the response of a company user email validation query. #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2551,7 +2548,7 @@ Contains the result of the `isEmailAvailable` query. #### Example ```json -{"is_email_available": false} +{"is_email_available": true} ``` @@ -2604,7 +2601,7 @@ Response returned when checking whether a customer is subscribed to a product al #### Example ```json -{"isSubscribed": false, "message": "abc123"} +{"isSubscribed": true, "message": "abc123"} ``` @@ -2629,12 +2626,12 @@ The note object for quote line item. ```json { - "created_at": "abc123", - "creator_id": 987, - "creator_name": "abc123", - "creator_type": 123, - "negotiable_quote_item_uid": "4", - "note": "abc123", + "created_at": "xyz789", + "creator_id": 123, + "creator_name": "xyz789", + "creator_type": 987, + "negotiable_quote_item_uid": 4, + "note": "xyz789", "note_uid": "4" } ``` @@ -2658,7 +2655,7 @@ A list of options of the selected bundle product. ```json { "label": "xyz789", - "uid": 4, + "uid": "4", "values": [ItemSelectedBundleOptionValue] } ``` @@ -2684,9 +2681,9 @@ A list of values for the selected bundle product. ```json { "price": Money, - "product_name": "xyz789", + "product_name": "abc123", "product_sku": "abc123", - "quantity": 987.65, + "quantity": 123.45, "uid": 4 } ``` @@ -2718,7 +2715,7 @@ A JSON scalar ```json { - "key": "abc123", + "key": "xyz789", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2739,8 +2736,8 @@ A JSON scalar ```json { - "key": "abc123", - "message": "xyz789", + "key": "xyz789", + "message": "abc123", "success": true } ``` @@ -2753,6 +2750,7 @@ A JSON scalar | Input Field | Description | |-------------|-------------| +| `checksum_sha256` - [`String`](/reference/graphql/saas/types-q-s.md#string) | Optional base64-encoded SHA-256 digest of the file, computed by the client before calling this mutation; when set, Amazon S3 rejects the upload if the received bytes don't match it | | `key` - [`String!`](/reference/graphql/saas/types-q-s.md#string) | The name of the file to be uploaded, cannot contain slashes | | `media_resource_type` - [`MediaResourceType!`](/reference/graphql/saas/types-k-p.md#mediaresourcetype) | The type of media resource being uploaded | @@ -2760,7 +2758,8 @@ A JSON scalar ```json { - "key": "xyz789", + "checksum_sha256": "abc123", + "key": "abc123", "media_resource_type": "NEGOTIABLE_QUOTE_ATTACHMENT" } ``` @@ -2781,8 +2780,8 @@ A JSON scalar ```json { - "expires_at": "abc123", - "key": "xyz789", - "upload_url": "xyz789" + "expires_at": "xyz789", + "key": "abc123", + "upload_url": "abc123" } ``` 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 7ecd3d8a1..eb8a011b7 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 @@ -58,9 +58,9 @@ Sets quote item note. ```json { - "note": "xyz789", + "note": "abc123", "quote_item_uid": 4, - "quote_uid": "4" + "quote_uid": 4 } ``` @@ -93,9 +93,9 @@ Contains basic information about a product image or video. ```json { - "disabled": true, - "label": "xyz789", - "position": 123, + "disabled": false, + "label": "abc123", + "position": 987, "types": ["xyz789"], "url": "xyz789" } @@ -199,7 +199,7 @@ Contains the customer's gift registry and any errors encountered. ```json { "gift_registry": GiftRegistry, - "status": false, + "status": true, "user_errors": [GiftRegistryItemsUserError] } ``` @@ -219,7 +219,7 @@ An input object that defines the items in a requisition list to be moved. #### Example ```json -{"requisitionListItemUids": [4]} +{"requisitionListItemUids": ["4"]} ``` @@ -262,9 +262,9 @@ Move Line Item to Requisition List. ```json { - "quote_item_uid": "4", + "quote_item_uid": 4, "quote_uid": "4", - "requisition_list_uid": 4 + "requisition_list_uid": "4" } ``` @@ -354,23 +354,23 @@ Contains details about a negotiable quote. "comments": [NegotiableQuoteComment], "created_at": "abc123", "custom_attributes": [CustomAttribute], - "email": "abc123", - "expiration_date": "xyz789", + "email": "xyz789", + "expiration_date": "abc123", "history": [NegotiableQuoteHistoryEntry], - "is_virtual": true, + "is_virtual": false, "items": [CartItemInterface], - "name": "xyz789", + "name": "abc123", "order": CustomerOrder, "prices": CartPrices, - "sales_rep_name": "xyz789", + "sales_rep_name": "abc123", "selected_payment_method": SelectedPaymentMethod, "shipping_addresses": [NegotiableQuoteShippingAddress], "status": "SUBMITTED", "template_id": 4, - "template_name": "xyz789", + "template_name": "abc123", "total_quantity": 123.45, "uid": "4", - "updated_at": "abc123" + "updated_at": "xyz789" } ``` @@ -428,23 +428,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", - "country_code": "xyz789", + "country_code": "abc123", "custom_attributes": [AttributeValueInput], "fax": "abc123", - "firstname": "abc123", + "firstname": "xyz789", "lastname": "xyz789", - "middlename": "abc123", - "postcode": "xyz789", - "prefix": "xyz789", + "middlename": "xyz789", + "postcode": "abc123", + "prefix": "abc123", "region": "xyz789", - "region_id": 123, + "region_id": 987, "save_in_address_book": true, "street": ["xyz789"], - "suffix": "xyz789", - "telephone": "abc123", - "vat_id": "abc123" + "suffix": "abc123", + "telephone": "xyz789", + "vat_id": "xyz789" } ``` @@ -487,23 +487,23 @@ Defines the billing or shipping address to be applied to the cart. ```json { "city": "abc123", - "company": "xyz789", - "company_address_id": "4", + "company": "abc123", + "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "xyz789", + "customer_address_uid": "4", + "fax": "abc123", + "firstname": "abc123", "lastname": "abc123", "middlename": "xyz789", - "postcode": "abc123", - "prefix": "abc123", + "postcode": "xyz789", + "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, "street": ["abc123"], - "suffix": "xyz789", + "suffix": "abc123", "telephone": "abc123", - "uid": "4", - "vat_id": "abc123" + "uid": 4, + "vat_id": "xyz789" } ``` @@ -525,9 +525,9 @@ Defines the company's state or province. ```json { - "code": "xyz789", - "label": "xyz789", - "region_id": 987 + "code": "abc123", + "label": "abc123", + "region_id": 123 } ``` @@ -562,23 +562,23 @@ Defines the company's state or province. ```json { - "city": "abc123", + "city": "xyz789", "company": "xyz789", "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, - "fax": "xyz789", - "firstname": "abc123", + "customer_address_uid": "4", + "fax": "abc123", + "firstname": "xyz789", "lastname": "abc123", - "middlename": "xyz789", + "middlename": "abc123", "postcode": "xyz789", "prefix": "abc123", "region": NegotiableQuoteAddressRegion, - "street": ["xyz789"], + "street": ["abc123"], "suffix": "abc123", "telephone": "abc123", - "uid": "4", + "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 @@ -634,7 +634,7 @@ Contains a single plain text comment from either the buyer or seller. { "attachments": [NegotiableQuoteCommentAttachment], "author": NegotiableQuoteUser, - "created_at": "abc123", + "created_at": "xyz789", "creator_type": "BUYER", "text": "xyz789", "uid": "4" @@ -658,8 +658,8 @@ Negotiable quote comment file attachment. ```json { - "name": "xyz789", - "url": "xyz789" + "name": "abc123", + "url": "abc123" } ``` @@ -716,7 +716,7 @@ Contains the commend provided by the buyer. ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "xyz789" + "comment": "abc123" } ``` @@ -738,7 +738,7 @@ Contains custom log entries added by third-party extensions. ```json { - "new_value": "abc123", + "new_value": "xyz789", "old_value": "xyz789", "title": "xyz789" } @@ -840,7 +840,7 @@ Contains details about a change for a negotiable quote. "changes": NegotiableQuoteHistoryChanges, "created_at": "abc123", "item_note": HistoryItemNoteData, - "uid": 4 + "uid": "4" } ``` @@ -981,7 +981,7 @@ An error indicating that an operation was attempted on a negotiable quote in an #### Example ```json -{"message": "xyz789"} +{"message": "abc123"} ``` @@ -1044,9 +1044,9 @@ Contains a reference document link for a negotiable quote template. ```json { - "document_identifier": "abc123", + "document_identifier": "xyz789", "document_name": "abc123", - "link_id": "4", + "link_id": 4, "reference_document_url": "xyz789" } ``` @@ -1085,24 +1085,24 @@ Contains a reference document link for a negotiable quote template. ```json { "available_shipping_methods": [AvailableShippingMethod], - "city": "abc123", + "city": "xyz789", "company": "xyz789", "company_address_id": 4, "country": NegotiableQuoteAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": "4", - "fax": "abc123", + "customer_address_uid": 4, + "fax": "xyz789", "firstname": "xyz789", "lastname": "abc123", - "middlename": "abc123", + "middlename": "xyz789", "postcode": "abc123", - "prefix": "abc123", + "prefix": "xyz789", "region": NegotiableQuoteAddressRegion, "selected_shipping_method": SelectedShippingMethod, - "street": ["abc123"], + "street": ["xyz789"], "suffix": "xyz789", "telephone": "xyz789", - "uid": "4", + "uid": 4, "vat_id": "xyz789" } ``` @@ -1127,9 +1127,9 @@ Defines shipping addresses for the negotiable quote. ```json { "address": NegotiableQuoteAddressInput, - "company_address_id": "4", + "company_address_id": 4, "customer_address_uid": "4", - "customer_notes": "abc123" + "customer_notes": "xyz789" } ``` @@ -1233,8 +1233,8 @@ Contains details about a negotiable quote template. { "buyer": NegotiableQuoteUser, "comments": [NegotiableQuoteComment], - "created_at": "abc123", - "expiration_date": "abc123", + "created_at": "xyz789", + "expiration_date": "xyz789", "history": [NegotiableQuoteHistoryEntry], "historyV2": [NegotiableQuoteTemplateHistoryEntry], "is_min_max_qty_used": false, @@ -1316,23 +1316,23 @@ Contains data for a negotiable quote template in a grid. ```json { "activated_at": "xyz789", - "company_name": "xyz789", - "created_at": "xyz789", - "expiration_date": "xyz789", - "is_min_max_qty_used": true, + "company_name": "abc123", + "created_at": "abc123", + "expiration_date": "abc123", + "is_min_max_qty_used": false, "last_ordered_at": "abc123", "last_shared_at": "xyz789", - "max_order_commitment": 123, + "max_order_commitment": 987, "min_negotiated_grand_total": 987.65, - "min_order_commitment": 987, + "min_order_commitment": 123, "name": "xyz789", "orders_placed": 123, "prices": CartPrices, - "sales_rep_name": "abc123", + "sales_rep_name": "xyz789", "state": "abc123", "status": "abc123", "submitted_by": "xyz789", - "template_id": 4, + "template_id": "4", "uid": "4", "updated_at": "xyz789" } @@ -1392,7 +1392,7 @@ Contains details about a change for a negotiable quote template. "change_type": "CREATED", "changes": NegotiableQuoteTemplateHistoryChanges, "created_at": "xyz789", - "uid": "4" + "uid": 4 } ``` @@ -1454,7 +1454,7 @@ Specifies the updated quantity of an item. #### Example ```json -{"item_id": 4, "max_qty": 987.65, "min_qty": 987.65, "quantity": 987.65} +{"item_id": 4, "max_qty": 123.45, "min_qty": 987.65, "quantity": 987.65} ``` @@ -1476,10 +1476,10 @@ Defines the reference document link to add to a negotiable quote template. ```json { - "document_identifier": "xyz789", - "document_name": "abc123", - "link_id": 4, - "reference_document_url": "xyz789" + "document_identifier": "abc123", + "document_name": "xyz789", + "link_id": "4", + "reference_document_url": "abc123" } ``` @@ -1504,7 +1504,7 @@ Defines shipping addresses for the negotiable quote template. { "address": NegotiableQuoteAddressInput, "company_address_id": 4, - "customer_address_uid": 4, + "customer_address_uid": "4", "customer_notes": "xyz789" } ``` @@ -1567,7 +1567,7 @@ Contains a list of negotiable templates that match the specified filter. "items": [NegotiableQuoteTemplateGridItem], "page_info": SearchResultPageInfo, "sort_fields": SortFields, - "total_count": 123 + "total_count": 987 } ``` @@ -1590,7 +1590,7 @@ Contains a list of negotiable templates that match the specified filter. #### Example ```json -{"quote_uid": 4} +{"quote_uid": "4"} ``` @@ -1675,10 +1675,7 @@ Contains an error message when an invalid UID was specified. #### Example ```json -{ - "message": "abc123", - "uid": "4" -} +{"message": "xyz789", "uid": 4} ``` @@ -1741,8 +1738,8 @@ A single cart item's source nomination. ```json { - "cart_item_uid": "4", - "source_code": "abc123" + "cart_item_uid": 4, + "source_code": "xyz789" } ``` @@ -1800,7 +1797,7 @@ A custom fee applied to the cart by an out-of-process webhook. { "amount": Money, "code": "abc123", - "label": "xyz789" + "label": "abc123" } ``` @@ -1819,7 +1816,7 @@ A custom fee applied to the cart by an out-of-process webhook. ```json { - "backend_integration_url": "xyz789", + "backend_integration_url": "abc123", "custom_config": [CustomConfigKeyValue] } ``` @@ -1942,20 +1939,20 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "city": "abc123", + "city": "xyz789", "company": "abc123", "company_address_id": "4", "country_code": "AF", "custom_attributesV2": [AttributeValueInterface], - "fax": "xyz789", - "firstname": "xyz789", - "lastname": "abc123", - "middlename": "xyz789", - "postcode": "xyz789", - "prefix": "abc123", + "fax": "abc123", + "firstname": "abc123", + "lastname": "xyz789", + "middlename": "abc123", + "postcode": "abc123", + "prefix": "xyz789", "region": "abc123", - "region_id": 4, - "street": ["abc123"], + "region_id": "4", + "street": ["xyz789"], "suffix": "abc123", "telephone": "xyz789", "vat_id": "xyz789" @@ -1964,6 +1961,42 @@ Contains detailed information about an order's billing and shipping addresses. +### OrderChainTotal + +Aggregated sales totals across every order in an order-edit chain. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `grand_total` - [`Money!`](#money) | The sum of grand total across every order in the chain, net of canceled amounts. | +| `order_count` - [`Int!`](/reference/graphql/saas/types-f-i.md#int) | The number of orders included in the chain aggregation. | +| `subtotal` - [`Money!`](#money) | The sum of subtotal across every order in the chain, net of canceled subtotal amounts. | +| `total_canceled` - [`Money!`](#money) | The sum of the amount canceled across every order in the chain. | +| `total_discounted` - [`Money!`](#money) | The total discount amount across every order in the chain, net of canceled discount amounts (non-negative). | +| `total_invoiced` - [`Money!`](#money) | The sum of the amount invoiced across every order in the chain. | +| `total_refunded` - [`Money!`](#money) | The sum of the amount refunded across every order in the chain. | +| `total_shipping` - [`Money!`](#money) | The sum of shipping amount across every order in the chain, net of canceled shipping amounts. | +| `total_tax` - [`Money!`](#money) | The sum of tax amount across every order in the chain, net of canceled tax amounts. | + +#### Example + +```json +{ + "grand_total": Money, + "order_count": 987, + "subtotal": Money, + "total_canceled": Money, + "total_discounted": Money, + "total_invoiced": Money, + "total_refunded": Money, + "total_shipping": Money, + "total_tax": Money +} +``` + + + ### OrderCustomerInfo #### Fields @@ -1980,11 +2013,11 @@ Contains detailed information about an order's billing and shipping addresses. ```json { - "firstname": "xyz789", - "lastname": "xyz789", - "middlename": "xyz789", - "prefix": "abc123", - "suffix": "abc123" + "firstname": "abc123", + "lastname": "abc123", + "middlename": "abc123", + "prefix": "xyz789", + "suffix": "xyz789" } ``` @@ -2027,24 +2060,24 @@ Contains detailed information about an order's billing and shipping addresses. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], - "free_gift_label": "abc123", + "free_gift_label": "xyz789", "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, - "id": "4", + "id": 4, "prices": OrderItemPrices, "product": ProductInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "xyz789", - "product_type": "xyz789", + "product_type": "abc123", "product_url_key": "xyz789", "quantity_canceled": 123.45, "quantity_invoiced": 987.65, "quantity_ordered": 987.65, - "quantity_refunded": 987.65, - "quantity_return_requested": 123.45, + "quantity_refunded": 123.45, + "quantity_return_requested": 987.65, "quantity_returned": 123.45, "quantity_shipped": 987.65, "selected_options": [OrderItemOption], @@ -2103,7 +2136,7 @@ Order item details. { "custom_attributes": [CustomAttribute], "discounts": [Discount], - "eligible_for_return": false, + "eligible_for_return": true, "entered_options": [OrderItemOption], "free_gift_label": "xyz789", "gift_message": GiftMessage, @@ -2111,20 +2144,20 @@ Order item details. "id": "4", "prices": OrderItemPrices, "product": ProductInterface, - "product_name": "abc123", + "product_name": "xyz789", "product_sale_price": Money, "product_sku": "abc123", - "product_type": "abc123", + "product_type": "xyz789", "product_url_key": "xyz789", - "quantity_canceled": 987.65, + "quantity_canceled": 123.45, "quantity_invoiced": 123.45, - "quantity_ordered": 123.45, + "quantity_ordered": 987.65, "quantity_refunded": 123.45, - "quantity_return_requested": 123.45, - "quantity_returned": 987.65, + "quantity_return_requested": 987.65, + "quantity_returned": 123.45, "quantity_shipped": 123.45, "selected_options": [OrderItemOption], - "status": "xyz789" + "status": "abc123" } ``` @@ -2145,8 +2178,8 @@ Represents order item options like selected or entered. ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -2207,8 +2240,8 @@ Contains details about the payment method used to pay for the order. ```json { "additional_data": [KeyValue], - "name": "abc123", - "type": "xyz789" + "name": "xyz789", + "type": "abc123" } ``` @@ -2233,9 +2266,9 @@ Contains order shipment details. ```json { "comments": [SalesCommentItem], - "id": 4, + "id": "4", "items": [ShipmentItemInterface], - "number": "xyz789", + "number": "abc123", "tracking": [ShipmentTracking] } ``` @@ -2363,7 +2396,7 @@ Defines the payment attribute. ```json { "key": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -2399,11 +2432,11 @@ Contains payment fields that are common to all types of payment methods. ```json { "code": "abc123", - "is_visible": true, - "payment_intent": "xyz789", + "is_visible": false, + "payment_intent": "abc123", "sdk_params": [SDKParams], "sort_order": "abc123", - "title": "xyz789" + "title": "abc123" } ``` @@ -2483,7 +2516,7 @@ Defines the payment method. ```json { "additional_data": [PaymentAttributeInput], - "code": "abc123", + "code": "xyz789", "payment_services_paypal_apple_pay": ApplePayMethodInput, "payment_services_paypal_fastlane": FastlaneMethodInput, "payment_services_paypal_google_pay": GooglePayMethodInput, @@ -2514,9 +2547,9 @@ Contains the payment order details ```json { "id": "abc123", - "mp_order_id": "abc123", + "mp_order_id": "xyz789", "payment_source_details": PaymentSourceDetails, - "status": "abc123" + "status": "xyz789" } ``` @@ -2535,7 +2568,7 @@ Contains the payment order details ```json { - "code": "abc123", + "code": "xyz789", "params": [SDKParams] } ``` @@ -2613,7 +2646,7 @@ The stored payment method available to the customer. { "details": "xyz789", "payment_method_code": "xyz789", - "public_hash": "abc123", + "public_hash": "xyz789", "type": "card" } ``` @@ -2662,7 +2695,7 @@ Contains attributes specific to tangible products. #### Example ```json -{"weight": 987.65} +{"weight": 123.45} ``` @@ -2699,17 +2732,17 @@ Defines Pickup Location information. "contact_name": "xyz789", "country_id": "xyz789", "description": "xyz789", - "email": "abc123", - "fax": "abc123", - "latitude": 123.45, + "email": "xyz789", + "fax": "xyz789", + "latitude": 987.65, "longitude": 987.65, - "name": "abc123", + "name": "xyz789", "phone": "xyz789", "pickup_location_code": "abc123", "postcode": "xyz789", - "region": "abc123", + "region": "xyz789", "region_id": 123, - "street": "abc123" + "street": "xyz789" } ``` @@ -2817,7 +2850,7 @@ Top level object returned in a pickup locations search. { "items": [PickupLocation], "page_info": SearchResultPageInfo, - "total_count": 987 + "total_count": 123 } ``` @@ -2936,7 +2969,7 @@ Specifies the purchase order to convert to an order. #### Example ```json -{"purchase_order_uid": "4"} +{"purchase_order_uid": 4} ``` @@ -2972,7 +3005,7 @@ Specifies the quote to be converted to an order. #### Example ```json -{"cart_id": "xyz789"} +{"cart_id": "abc123"} ``` @@ -3071,7 +3104,7 @@ Specifies the amount and type of price adjustment. #### Example ```json -{"amount": 987.65, "code": "xyz789"} +{"amount": 987.65, "code": "abc123"} ``` @@ -3092,7 +3125,7 @@ Can be used to retrieve the main price details in case of bundle product ```json { - "discount_percentage": 123.45, + "discount_percentage": 987.65, "main_final_price": 987.65, "main_price": 123.45 } @@ -3174,7 +3207,7 @@ Input to identify a product by SKU for a price alert subscription. #### Example ```json -{"sku": "xyz789"} +{"sku": "abc123"} ``` @@ -3192,7 +3225,7 @@ Input to identify a product by SKU for a stock alert subscription. #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3254,8 +3287,8 @@ Contains a product attribute code and value. ```json { "attribute_type": "abc123", - "code": 4, - "url": "xyz789", + "code": "4", + "url": "abc123", "value": "abc123" } ``` @@ -3298,7 +3331,7 @@ Contains the discount applied to a product price. #### Example ```json -{"amount_off": 123.45, "percent_off": 123.45} +{"amount_off": 123.45, "percent_off": 987.65} ``` @@ -3322,10 +3355,10 @@ Contains product image information, including the image URL and label. ```json { "disabled": false, - "label": "xyz789", - "position": 123, + "label": "abc123", + "position": 987, "types": ["xyz789"], - "url": "xyz789" + "url": "abc123" } ``` @@ -3361,7 +3394,7 @@ Product Information used for Pickup Locations search. #### Example ```json -{"sku": "abc123"} +{"sku": "xyz789"} ``` @@ -3433,29 +3466,29 @@ Contains fields that are common to all types of products. ```json { - "canonical_url": "abc123", + "canonical_url": "xyz789", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, + "gift_message_available": false, "gift_wrapping_available": true, "gift_wrapping_price": Money, "image": ProductImage, - "is_returnable": "abc123", - "manufacturer": 987, - "max_sale_qty": 123.45, + "is_returnable": "xyz789", + "manufacturer": 123, + "max_sale_qty": 987.65, "media_gallery": [MediaGalleryInterface], - "meta_description": "abc123", + "meta_description": "xyz789", "meta_keyword": "abc123", - "meta_title": "abc123", + "meta_title": "xyz789", "min_sale_qty": 987.65, - "name": "abc123", - "new_from_date": "abc123", + "name": "xyz789", + "new_from_date": "xyz789", "new_to_date": "xyz789", - "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], @@ -3467,14 +3500,14 @@ Contains fields that are common to all types of products. "short_description": ComplexTextValue, "sku": "xyz789", "small_image": ProductImage, - "special_price": 123.45, - "special_to_date": "abc123", + "special_price": 987.65, + "special_to_date": "xyz789", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789" + "url_key": "abc123" } ``` @@ -3500,9 +3533,9 @@ An implementation of `ProductLinksInterface`. { "link_type": "xyz789", "linked_product_sku": "xyz789", - "linked_product_type": "abc123", - "position": 987, - "sku": "abc123" + "linked_product_type": "xyz789", + "position": 123, + "sku": "xyz789" } ``` @@ -3532,11 +3565,11 @@ Contains information about linked products, including the link type and product ```json { - "link_type": "xyz789", - "linked_product_sku": "xyz789", - "linked_product_type": "xyz789", + "link_type": "abc123", + "linked_product_sku": "abc123", + "linked_product_type": "abc123", "position": 987, - "sku": "abc123" + "sku": "xyz789" } ``` @@ -3558,8 +3591,8 @@ Contains basic information about the image asset. ```json { - "asset_id": "xyz789", - "media_type": "xyz789", + "asset_id": "abc123", + "media_type": "abc123", "media_url": "abc123" } ``` @@ -3582,7 +3615,7 @@ Contains basic information about the video asset. ```json { - "media_type": "abc123", + "media_type": "xyz789", "video_asset_id": "abc123", "video_media_url": "xyz789" } @@ -3609,8 +3642,8 @@ Contains a link to a video file and basic information about the video. ```json { - "media_type": "abc123", - "video_description": "xyz789", + "media_type": "xyz789", + "video_description": "abc123", "video_metadata": "abc123", "video_provider": "xyz789", "video_title": "xyz789", @@ -3667,8 +3700,8 @@ Contains details of a product review. ```json { "average_rating": 123.45, - "created_at": "xyz789", - "nickname": "xyz789", + "created_at": "abc123", + "nickname": "abc123", "product": ProductInterface, "ratings_breakdown": [ProductReviewRating], "summary": "xyz789", @@ -3694,7 +3727,7 @@ Contains data about a single aspect of a product review. ```json { "name": "abc123", - "value": "xyz789" + "value": "abc123" } ``` @@ -3716,7 +3749,7 @@ Contains the reviewer's rating for a single aspect of a review. ```json { "id": "abc123", - "value_id": "abc123" + "value_id": "xyz789" } ``` @@ -3855,7 +3888,7 @@ Contains the output of a `productSearch` query "facets": [Aggregation], "items": [ProductSearchItem], "page_info": SearchResultPageInfo, - "related_terms": ["xyz789"], + "related_terms": ["abc123"], "suggestions": ["abc123"], "total_count": 987, "warnings": [ProductSearchWarning] @@ -3878,7 +3911,7 @@ The product attribute to sort on #### Example ```json -{"attribute": "xyz789", "direction": "ASC"} +{"attribute": "abc123", "direction": "ASC"} ``` @@ -3898,7 +3931,7 @@ Structured warning with code and message for easier client handling ```json { - "code": "xyz789", + "code": "abc123", "message": "abc123" } ``` @@ -3944,10 +3977,10 @@ Contains information about a product video. ```json { "disabled": false, - "label": "abc123", - "position": 123, + "label": "xyz789", + "position": 987, "types": ["xyz789"], - "url": "abc123", + "url": "xyz789", "video_content": ProductMediaGalleryEntriesVideoContent } ``` @@ -3970,6 +4003,7 @@ Defines the product fields available to the SimpleProductView and ComplexProduct | `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | | `images` - [`[ProductViewImage]`](#productviewimage) | A list of images defined for the product. | | `videos` - [`[ProductViewVideo]`](#productviewvideo) | A list of videos defined for the product. | +| `gallery` - [`[ProductViewMedia]`](#productviewmedia) | A list of all images and videos defined for the product, ordered as a single media gallery. | | `lastModifiedAt` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | Date and time when the product was last updated. | | `metaDescription` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A brief overview of the product for search results listings. | | `metaKeyword` - [`String`](/reference/graphql/saas/types-q-s.md#string) | A comma-separated list of keywords that are visible only to search engines. | @@ -3997,29 +4031,30 @@ Defines the product fields available to the SimpleProductView and ComplexProduct ```json { - "addToCartAllowed": false, + "addToCartAllowed": true, "inStock": true, - "lowStock": true, + "lowStock": false, "attributes": [ProductViewAttribute], "description": "xyz789", - "id": "4", + "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], + "gallery": [ProductViewImage], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", + "metaDescription": "abc123", "metaKeyword": "xyz789", - "metaTitle": "abc123", + "metaTitle": "xyz789", "name": "xyz789", - "shortDescription": "xyz789", + "shortDescription": "abc123", "inputOptions": [ProductViewInputOption], "sku": "abc123", - "externalId": "xyz789", + "externalId": "abc123", "externalIds": [ExternalId], - "url": "abc123", - "urlKey": "xyz789", + "url": "xyz789", + "urlKey": "abc123", "links": [ProductViewLink], - "queryType": "abc123", - "visibility": "xyz789" + "queryType": "xyz789", + "visibility": "abc123" } ``` @@ -4043,7 +4078,7 @@ A container for customer-defined attributes that are displayed the storefront. ```json { "label": "xyz789", - "name": "xyz789", + "name": "abc123", "roles": ["xyz789"], "value": {} } @@ -4256,7 +4291,7 @@ Contains details about a product image. { "label": "abc123", "roles": ["xyz789"], - "url": "abc123" + "url": "xyz789" } ``` @@ -4286,15 +4321,15 @@ Product options provide a way to configure products by making selections of part ```json { "id": 4, - "title": "xyz789", + "title": "abc123", "required": false, - "type": "abc123", + "type": "xyz789", "markupAmount": 123.45, "suffix": "abc123", "sortOrder": 987, "range": ProductViewInputOptionRange, "imageSize": ProductViewInputOptionImageSize, - "fileExtensions": "xyz789" + "fileExtensions": "abc123" } ``` @@ -4314,7 +4349,7 @@ Dimensions of the image associated with the input option. #### Example ```json -{"width": 987, "height": 123} +{"width": 123, "height": 987} ``` @@ -4333,7 +4368,7 @@ Lists the value range associated with a `ProductViewInputOption`. For example, i #### Example ```json -{"from": 987.65, "to": 123.45} +{"from": 123.45, "to": 123.45} ``` @@ -4354,12 +4389,31 @@ The product link type. Contains details about product links for related products ```json { "product": ProductView, - "linkTypes": ["abc123"] + "linkTypes": ["xyz789"] } ``` +### ProductViewMedia + +A single entry in the product media gallery. The entry can be either an image or a video. + +#### Types + +| Union Types | +|-------------| +| [`ProductViewImage`](#productviewimage) | +| [`ProductViewVideo`](#productviewvideo) | + +#### Example + +```json +ProductViewImage +``` + + + ### ProductViewMoney Defines a monetary value, including a numeric value and a currency code. @@ -4398,9 +4452,9 @@ Product options provide a way to configure products by making selections of part ```json { "id": 4, - "multi": false, + "multi": true, "required": false, - "title": "abc123", + "title": "xyz789", "values": [ProductViewOptionValue] } ``` @@ -4432,8 +4486,8 @@ Defines the product fields available to the ProductViewOptionValueProduct and Pr ```json { "id": 4, - "title": "abc123", - "inStock": true + "title": "xyz789", + "inStock": false } ``` @@ -4455,9 +4509,9 @@ An implementation of ProductViewOptionValue for configuration values. ```json { - "id": 4, + "id": "4", "title": "xyz789", - "inStock": true + "inStock": false } ``` @@ -4488,8 +4542,8 @@ An implementation of ProductViewOptionValue that adds details about a simple pro "product": SimpleProductView, "quantity": 123.45, "canEditQuantity": true, - "title": "xyz789", - "inStock": true + "title": "abc123", + "inStock": false } ``` @@ -4514,7 +4568,7 @@ An implementation of ProductViewOptionValueSwatch for swatches. ```json { "id": 4, - "title": "xyz789", + "title": "abc123", "type": "TEXT", "value": "xyz789", "inStock": true @@ -4601,7 +4655,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, #### Example ```json -{"in": [987.65]} +{"in": [123.45]} ``` @@ -4642,7 +4696,7 @@ Minimum quantity (inclusive) required to activate this tier price. For example, #### Example ```json -{"gte": 123.45, "lt": 987.65} +{"gte": 123.45, "lt": 123.45} ``` @@ -4710,8 +4764,8 @@ Contains details about a product video. For example, a video of the product bein { "preview": ProductViewImage, "url": "abc123", - "description": "abc123", - "title": "abc123" + "description": "xyz789", + "title": "xyz789" } ``` @@ -4753,7 +4807,7 @@ Contains error details for a failed public requisition list operation. #### Example ```json -{"code": "NOT_PUBLIC", "message": "abc123"} +{"code": "NOT_PUBLIC", "message": "xyz789"} ``` @@ -4836,15 +4890,15 @@ Contains details about a purchase order. "approval_flow": [PurchaseOrderRuleApprovalFlow], "available_actions": ["REJECT"], "comments": [PurchaseOrderComment], - "created_at": "xyz789", + "created_at": "abc123", "created_by": Customer, "history_log": [PurchaseOrderHistoryItem], "number": "abc123", "order": CustomerOrder, "quote": Cart, "status": "PENDING", - "uid": "4", - "updated_at": "xyz789" + "uid": 4, + "updated_at": "abc123" } ``` @@ -4909,9 +4963,9 @@ Contains details about a single event in the approval flow of the purchase order { "message": "abc123", "name": "abc123", - "role": "xyz789", + "role": "abc123", "status": "PENDING", - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -4963,11 +5017,11 @@ Contains details about a purchase order approval rule. "condition": PurchaseOrderApprovalRuleConditionInterface, "created_at": "abc123", "created_by": "abc123", - "description": "abc123", - "name": "abc123", + "description": "xyz789", + "name": "xyz789", "status": "ENABLED", - "uid": 4, - "updated_at": "xyz789" + "uid": "4", + "updated_at": "abc123" } ``` @@ -5082,7 +5136,7 @@ Defines a new purchase order approval rule. ```json { "applies_to": [4], - "approvers": ["4"], + "approvers": [4], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "xyz789", "name": "abc123", @@ -5169,7 +5223,7 @@ Contains the approval rules that the customer can see. { "items": [PurchaseOrderApprovalRule], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5240,7 +5294,7 @@ Contains details about a status change. { "activity": "abc123", "created_at": "xyz789", - "message": "xyz789", + "message": "abc123", "uid": 4 } ``` @@ -5311,7 +5365,7 @@ Contains a list of purchase orders. { "items": [PurchaseOrder], "page_info": SearchResultPageInfo, - "total_count": 123 + "total_count": 987 } ``` @@ -5378,7 +5432,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": false, + "require_my_approval": true, "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 10f82d0e8..eef8afa19 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,7 +54,7 @@ Sets quote template expiration date. ```json { - "expiration_date": "xyz789", + "expiration_date": "abc123", "template_id": 4 } ``` @@ -79,8 +79,8 @@ Sets quote item note. ```json { "item_id": 4, - "item_uid": 4, - "note": "xyz789", + "item_uid": "4", + "note": "abc123", "templateId": 4 } ``` @@ -103,7 +103,7 @@ Contains a notification message for a negotiable quote template. ```json { "message": "abc123", - "type": "xyz789" + "type": "abc123" } ``` @@ -229,14 +229,14 @@ Contains reCAPTCHA form configuration details. ```json { - "badge_position": "xyz789", - "language_code": "abc123", + "badge_position": "abc123", + "language_code": "xyz789", "minimum_score": 123.45, "re_captcha_type": "INVISIBLE", - "technical_failure_message": "abc123", - "theme": "abc123", - "validation_failure_message": "abc123", - "website_key": "abc123" + "technical_failure_message": "xyz789", + "theme": "xyz789", + "validation_failure_message": "xyz789", + "website_key": "xyz789" } ``` @@ -268,9 +268,9 @@ Contains reCAPTCHA V3-Invisible configuration details. "forms": ["PLACE_ORDER"], "is_enabled": false, "language_code": "abc123", - "minimum_score": 987.65, + "minimum_score": 123.45, "theme": "abc123", - "website_key": "abc123" + "website_key": "xyz789" } ``` @@ -294,7 +294,7 @@ Contains reCAPTCHA configuration for a specific form type. { "configurations": ReCaptchaConfiguration, "form_type": "PLACE_ORDER", - "is_enabled": true + "is_enabled": false } ``` @@ -369,16 +369,16 @@ Recommendation Unit containing product and other details ```json { - "displayOrder": 987, - "pageType": "xyz789", + "displayOrder": 123, + "pageType": "abc123", "productsView": [ProductView], - "storefrontLabel": "abc123", - "totalProducts": 123, + "storefrontLabel": "xyz789", + "totalProducts": 987, "typeId": "xyz789", - "unitId": "abc123", - "unitName": "abc123", + "unitId": "xyz789", + "unitName": "xyz789", "label": "xyz789", - "userError": "abc123" + "userError": "xyz789" } ``` @@ -398,7 +398,7 @@ Recommendations response #### Example ```json -{"results": [RecommendationUnit], "totalResults": 123} +{"results": [RecommendationUnit], "totalResults": 987} ``` @@ -419,7 +419,7 @@ Recommendations response { "code": "abc123", "id": 987, - "name": "abc123" + "name": "xyz789" } ``` @@ -443,11 +443,11 @@ A single cart item whose source nomination was rejected. ```json { - "available_qty": 123.45, + "available_qty": 987.65, "cart_item_uid": "4", "code": "UNKNOWN_SOURCE", - "message": "xyz789", - "requested_qty": 123.45 + "message": "abc123", + "requested_qty": 987.65 } ``` @@ -504,7 +504,7 @@ Remove coupons from the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "coupon_codes": ["abc123"] } ``` @@ -619,7 +619,10 @@ Specifies which items to remove from the cart. #### Example ```json -{"cart_id": "xyz789", "cart_item_uid": 4} +{ + "cart_id": "abc123", + "cart_item_uid": "4" +} ``` @@ -656,7 +659,10 @@ 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" +} ``` @@ -693,7 +699,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} ``` @@ -712,7 +718,7 @@ Defines which products to remove from a compare list. #### Example ```json -{"products": [4], "uid": 4} +{"products": [4], "uid": "4"} ``` @@ -752,7 +758,7 @@ Defines the tracking information to delete. #### Example ```json -{"return_shipping_tracking_uid": 4} +{"return_shipping_tracking_uid": "4"} ``` @@ -806,7 +812,7 @@ Defines the input required to run the `removeStoreCreditFromCart` mutation. #### Example ```json -{"cart_id": "abc123"} +{"cart_id": "xyz789"} ``` @@ -845,8 +851,8 @@ Sets new name for a negotiable quote. ```json { - "quote_comment": "abc123", - "quote_name": "abc123", + "quote_comment": "xyz789", + "quote_name": "xyz789", "quote_uid": 4 } ``` @@ -939,7 +945,7 @@ Defines properties of a negotiable quote request. "cart_id": "4", "comment": NegotiableQuoteCommentInput, "is_draft": true, - "quote_name": "abc123" + "quote_name": "xyz789" } ``` @@ -999,9 +1005,9 @@ Contains information needed to start a return request. ```json { "comment_text": "xyz789", - "contact_email": "xyz789", + "contact_email": "abc123", "items": [RequestReturnItemInput], - "order_uid": "4" + "order_uid": 4 } ``` @@ -1027,8 +1033,8 @@ Contains details about an item to be returned. "entered_custom_attributes": [ EnteredCustomAttributeInput ], - "order_item_uid": 4, - "quantity_to_return": 987.65, + "order_item_uid": "4", + "quantity_to_return": 123.45, "selected_custom_attributes": [ SelectedCustomAttributeInput ] @@ -1084,12 +1090,12 @@ Defines the contents of a requisition list. "description": "abc123", "is_public": true, "items": RequistionListItems, - "items_count": 123, - "name": "abc123", + "items_count": 987, + "name": "xyz789", "requisition_list_items": RequisitionListItems, - "token": "4", + "token": 4, "uid": 4, - "updated_at": "xyz789" + "updated_at": "abc123" } ``` @@ -1149,7 +1155,7 @@ The interface for requisition list items. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "xyz789", + "sku": "abc123", "uid": "4" } ``` @@ -1199,10 +1205,10 @@ Defines the items to add. ```json { "entered_options": [EnteredOptionInput], - "parent_sku": "xyz789", - "quantity": 987.65, + "parent_sku": "abc123", + "quantity": 123.45, "selected_options": ["abc123"], - "sku": "abc123" + "sku": "xyz789" } ``` @@ -1349,10 +1355,10 @@ Contains details about a return comment. ```json { - "author_name": "abc123", + "author_name": "xyz789", "created_at": "abc123", "text": "xyz789", - "uid": 4 + "uid": "4" } ``` @@ -1406,7 +1412,7 @@ Contains details about a product being returned. "quantity": 123.45, "request_quantity": 987.65, "status": "PENDING", - "uid": "4" + "uid": 4 } ``` @@ -1438,15 +1444,15 @@ Return Item attribute metadata. ```json { - "code": 4, + "code": "4", "default_value": "xyz789", "entity_type": "CATALOG_PRODUCT", - "frontend_class": "abc123", + "frontend_class": "xyz789", "frontend_input": "BOOLEAN", "input_filter": "NONE", - "is_required": true, + "is_required": false, "is_unique": false, - "label": "xyz789", + "label": "abc123", "multiline_count": 123, "options": [CustomAttributeOptionInterface], "sort_order": 987, @@ -1525,7 +1531,7 @@ Contains details about the shipping address used for receiving returned items. "postcode": "abc123", "region": Region, "street": ["xyz789"], - "telephone": "abc123" + "telephone": "xyz789" } ``` @@ -1545,10 +1551,7 @@ Contains details about the carrier on a return. #### Example ```json -{ - "label": "abc123", - "uid": "4" -} +{"label": "xyz789", "uid": 4} ``` @@ -1747,7 +1750,7 @@ Contain details about the reward points transaction. { "balance": RewardPointsAmount, "change_reason": "xyz789", - "date": "xyz789", + "date": "abc123", "points_change": 123.45 } ``` @@ -1790,7 +1793,7 @@ Contains details about customer's reward points rate. #### Example ```json -{"currency_amount": 123.45, "points": 987.65} +{"currency_amount": 123.45, "points": 123.45} ``` @@ -1850,7 +1853,7 @@ Defines the name and value of a SDK parameter ```json { "name": "xyz789", - "value": "abc123" + "value": "xyz789" } ``` @@ -1893,7 +1896,7 @@ For use on string and other scalar product fields #### Example ```json -{"count": 987, "id": 4, "title": "abc123"} +{"count": 123, "id": 4, "title": "xyz789"} ``` @@ -1937,12 +1940,12 @@ A product attribute to filter on ```json { - "attribute": "abc123", + "attribute": "xyz789", "contains": "xyz789", "eq": "abc123", "in": ["xyz789"], "range": SearchRangeInput, - "startsWith": "xyz789" + "startsWith": "abc123" } ``` @@ -1962,7 +1965,7 @@ A range of numeric values for use in a search #### Example ```json -{"from": 123.45, "to": 123.45} +{"from": 123.45, "to": 987.65} ``` @@ -2006,10 +2009,10 @@ Provides navigation for the query response. { "cart_id": "xyz789", "entered_options": [EnteredOptionInput], - "quantity": 987, + "quantity": 123, "rule_id": 987, - "selected_options": [4], - "sku": "xyz789" + "selected_options": ["4"], + "sku": "abc123" } ``` @@ -2048,9 +2051,9 @@ Contains details about a selected bundle option. ```json { - "label": "abc123", + "label": "xyz789", "type": "xyz789", - "uid": 4, + "uid": "4", "values": [SelectedBundleOptionValue] } ``` @@ -2078,7 +2081,7 @@ Contains details about a value for a selected bundle option. "label": "xyz789", "original_price": Money, "priceV2": Money, - "quantity": 123.45, + "quantity": 987.65, "uid": "4" } ``` @@ -2105,7 +2108,7 @@ Contains details about a selected configurable option. "configurable_product_option_uid": "4", "configurable_product_option_value_uid": 4, "option_label": "abc123", - "value_label": "xyz789" + "value_label": "abc123" } ``` @@ -2155,8 +2158,8 @@ Identifies a customized product that has been placed in a cart. "customizable_option_uid": 4, "is_required": false, "label": "abc123", - "sort_order": 123, - "type": "xyz789", + "sort_order": 987, + "type": "abc123", "values": [SelectedCustomizableOptionValue] } ``` @@ -2180,10 +2183,10 @@ Identifies the value of the selected customized option. ```json { - "customizable_option_value_uid": "4", + "customizable_option_value_uid": 4, "label": "xyz789", "price": CartItemSelectedOptionValuePrice, - "value": "xyz789" + "value": "abc123" } ``` @@ -2240,7 +2243,7 @@ Contains details about the selected shipping method and carrier. "amount": Money, "carrier_code": "xyz789", "carrier_title": "abc123", - "method_code": "abc123", + "method_code": "xyz789", "method_title": "abc123", "price_excl_tax": Money, "price_incl_tax": Money @@ -2263,7 +2266,10 @@ Specifies which negotiable quote to send for review. #### Example ```json -{"comment": NegotiableQuoteCommentInput, "quote_uid": 4} +{ + "comment": NegotiableQuoteCommentInput, + "quote_uid": "4" +} ``` @@ -2359,7 +2365,10 @@ Defines the company custom attributes. #### Example ```json -{"custom_attributes": [CustomAttributeInput], "id": 4} +{ + "custom_attributes": [CustomAttributeInput], + "id": "4" +} ``` @@ -2440,11 +2449,11 @@ Defines the gift options applied to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "gift_message": GiftMessageInput, "gift_receipt_included": true, "gift_wrapping_id": "4", - "printed_card_included": false + "printed_card_included": true } ``` @@ -2582,7 +2591,7 @@ Defines the payment method of the specified negotiable quote. ```json { "payment_method": NegotiableQuotePaymentMethodInput, - "quote_uid": 4 + "quote_uid": "4" } ``` @@ -2621,7 +2630,7 @@ Defines the shipping address to assign to the negotiable quote. ```json { - "quote_uid": "4", + "quote_uid": 4, "shipping_addresses": [ NegotiableQuoteShippingAddressInput ] @@ -2725,7 +2734,7 @@ Input for the setNominatedSourceOnCartItems mutation. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "items": [NominatedSourceItemInput] } ``` @@ -2769,7 +2778,7 @@ Applies a payment method to the cart. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "payment_method": PaymentMethodInput } ``` @@ -2809,7 +2818,7 @@ Specifies an array of addresses to use for shipping. ```json { - "cart_id": "abc123", + "cart_id": "xyz789", "shipping_addresses": [ShippingAddressInput] } ``` @@ -2890,7 +2899,7 @@ Defines a gift registry invitee. ```json { "email": "xyz789", - "name": "xyz789" + "name": "abc123" } ``` @@ -2952,7 +2961,7 @@ An input object that identifies the requisition list to share and the email addr ```json { "emails": ["abc123"], - "requisition_list_uid": "4" + "requisition_list_uid": 4 } ``` @@ -2994,7 +3003,10 @@ An input object that defines which requisition list shared with company users th #### Example ```json -{"customerUids": [4], "requisitionListUid": 4} +{ + "customerUids": ["4"], + "requisitionListUid": "4" +} ``` @@ -3014,7 +3026,7 @@ Result of sharing a requisition list by email. ```json { - "sent_count": 987, + "sent_count": 123, "user_errors": [ShareRequisitionListUserError] } ``` @@ -3098,7 +3110,7 @@ Shared requisition list view for a recipient. ```json { "requisition_list": RequisitionList, - "sender_name": "xyz789" + "sender_name": "abc123" } ``` @@ -3140,7 +3152,7 @@ Defines whether bundle items must be shipped together. ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "xyz789", "product_sale_price": Money, @@ -3178,12 +3190,12 @@ Order shipment item details. ```json { - "id": 4, + "id": "4", "order_item": OrderItemInterface, "product_name": "abc123", "product_sale_price": Money, "product_sku": "abc123", - "quantity_shipped": 123.45 + "quantity_shipped": 987.65 } ``` @@ -3207,7 +3219,7 @@ Contains order shipment tracking details. ```json { "carrier": "xyz789", - "number": "xyz789", + "number": "abc123", "title": "abc123", "tracking_url": "xyz789" } @@ -3230,7 +3242,7 @@ A simple key value object. ```json { - "key": "abc123", + "key": "xyz789", "value": "abc123" } ``` @@ -3257,10 +3269,10 @@ Defines a single shipping address. ```json { "address": CartAddressInput, - "company_address_id": 4, + "company_address_id": "4", "customer_address_id": 123, - "customer_address_uid": 4, - "customer_notes": "xyz789", + "customer_address_uid": "4", + "customer_notes": "abc123", "pickup_location_code": "xyz789" } ``` @@ -3307,28 +3319,28 @@ Contains shipping addresses and methods. { "available_shipping_methods": [AvailableShippingMethod], "cart_items_v2": [CartItemInterface], - "city": "abc123", + "city": "xyz789", "company": "abc123", "company_address_id": "4", "country": CartAddressCountry, "custom_attributes": [AttributeValueInterface], - "customer_address_uid": 4, + "customer_address_uid": "4", "customer_notes": "xyz789", - "fax": "xyz789", + "fax": "abc123", "firstname": "xyz789", - "id": 123, + "id": 987, "lastname": "xyz789", "middlename": "xyz789", - "pickup_location_code": "abc123", + "pickup_location_code": "xyz789", "postcode": "xyz789", - "prefix": "xyz789", + "prefix": "abc123", "region": CartAddressRegion, "same_as_billing": true, "selected_shipping_method": SelectedShippingMethod, - "street": ["xyz789"], - "suffix": "xyz789", + "street": ["abc123"], + "suffix": "abc123", "telephone": "xyz789", - "uid": 4, + "uid": "4", "vat_id": "abc123" } ``` @@ -3397,7 +3409,7 @@ Defines the shipping carrier and method. ```json { "carrier_code": "xyz789", - "method_code": "xyz789" + "method_code": "abc123" } ``` @@ -3439,7 +3451,7 @@ An implementation for simple product cart items. ```json { "available_gift_wrapping": [GiftWrapping], - "backorder_message": "xyz789", + "backorder_message": "abc123", "custom_attributes": [CustomAttribute], "customizable_options": [SelectedCustomizableOption], "discount": [Discount], @@ -3447,10 +3459,10 @@ An implementation for simple product cart items. "gift_message": GiftMessage, "gift_wrapping": GiftWrapping, "is_available": false, - "is_free_gift": true, + "is_free_gift": false, "is_salable": false, - "max_qty": 123.45, - "min_qty": 987.65, + "max_qty": 987.65, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "xyz789", @@ -3522,50 +3534,50 @@ Defines a simple product, which is tangible and is usually sold in single units ```json { - "canonical_url": "xyz789", + "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, - "gift_message_available": true, - "gift_wrapping_available": true, + "gift_message_available": false, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 123, - "max_sale_qty": 987.65, + "manufacturer": 987, + "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], - "meta_description": "xyz789", + "meta_description": "abc123", "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_title": "abc123", "min_sale_qty": 987.65, - "name": "xyz789", - "new_from_date": "xyz789", - "new_to_date": "abc123", + "name": "abc123", + "new_from_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "abc123", + "options_container": "xyz789", "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", "small_image": ProductImage, - "special_price": 987.65, + "special_price": 123.45, "special_to_date": "abc123", "stock_status": "IN_STOCK", - "swatch_image": "abc123", + "swatch_image": "xyz789", "thumbnail": ProductImage, - "uid": "4", + "uid": 4, "upsell_products": [ProductInterface], - "url_key": "xyz789", - "weight": 987.65 + "url_key": "abc123", + "weight": 123.45 } ``` @@ -3587,6 +3599,7 @@ Represents a single-SKU product without selectable variants. Because there are n | `id` - [`ID!`](/reference/graphql/saas/types-f-i.md#id) | The product ID, generated as a composite key, unique per locale. | | `images` - [`[ProductViewImage]`](/reference/graphql/saas/types-k-p.md#productviewimage) | A list of images defined for the product. Possible values include `image`, `small_image`, and `swatch`. | | `videos` - [`[ProductViewVideo]`](/reference/graphql/saas/types-k-p.md#productviewvideo) | A list of videos defined for the product. | +| `gallery` - [`[ProductViewMedia]`](/reference/graphql/saas/types-k-p.md#productviewmedia) | A list of all images and videos defined for the product, ordered as a single media gallery. | | `inputOptions` - [`[ProductViewInputOption]`](/reference/graphql/saas/types-k-p.md#productviewinputoption) | A list of input options. For example, a text field, a number field or a date field. *(Deprecated: This field is deprecated and will be removed.)* | | `lastModifiedAt` - [`DateTime`](/reference/graphql/saas/types-c-e.md#datetime) | Date and time when the product was last updated. | | `metaDescription` - [`String`](#string) | A brief overview of the product for search results listings. | @@ -3616,19 +3629,20 @@ Represents a single-SKU product without selectable variants. Because there are n "id": 4, "images": [ProductViewImage], "videos": [ProductViewVideo], + "gallery": [ProductViewImage], "inputOptions": [ProductViewInputOption], "lastModifiedAt": "2007-12-03T10:15:30Z", - "metaDescription": "xyz789", - "metaKeyword": "xyz789", - "metaTitle": "xyz789", + "metaDescription": "abc123", + "metaKeyword": "abc123", + "metaTitle": "abc123", "name": "abc123", "price": ProductViewPrice, "shortDescription": "abc123", - "sku": "abc123", + "sku": "xyz789", "externalId": "xyz789", "externalIds": [ExternalId], - "url": "xyz789", - "urlKey": "abc123", + "url": "abc123", + "urlKey": "xyz789", "links": [ProductViewLink], "queryType": "abc123", "visibility": "xyz789" @@ -3684,12 +3698,12 @@ Contains a simple product wish list item. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], "description": "xyz789", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -3703,17 +3717,13 @@ 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. 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. | +| `sources` - [`[SourceAvailability]!`](#sourceavailability) | Availability at each reported source. | #### Example ```json { - "backorder_message": "xyz789", - "is_saleable": true, "sku": "abc123", "sources": [SourceAvailability] } @@ -3737,9 +3747,9 @@ Smart button payment inputs ```json { - "payment_source": "abc123", - "payments_order_id": "xyz789", - "paypal_order_id": "abc123" + "payment_source": "xyz789", + "payments_order_id": "abc123", + "paypal_order_id": "xyz789" } ``` @@ -3767,17 +3777,17 @@ Smart button payment inputs ```json { - "app_switch_when_available": true, + "app_switch_when_available": false, "button_styles": ButtonStyles, "code": "abc123", "display_message": false, "display_venmo": false, "is_visible": false, "message_styles": MessageStyles, - "payment_intent": "abc123", + "payment_intent": "xyz789", "sdk_params": [SDKParams], - "sort_order": "abc123", - "title": "abc123" + "sort_order": "xyz789", + "title": "xyz789" } ``` @@ -3817,8 +3827,8 @@ Defines a possible sort field. ```json { - "label": "abc123", - "value": "abc123" + "label": "xyz789", + "value": "xyz789" } ``` @@ -3839,7 +3849,7 @@ Contains a default value for sort fields and all available sort fields. ```json { - "default": "abc123", + "default": "xyz789", "options": [SortField] } ``` @@ -3913,8 +3923,8 @@ Contains product attributes that be used for sorting in a `productSearch` query ```json { - "attribute": "abc123", - "frontendInput": "abc123", + "attribute": "xyz789", + "frontendInput": "xyz789", "label": "abc123", "numeric": false } @@ -3941,10 +3951,10 @@ Availability of a SKU at a single inventory source. ```json { - "available_qty": 123.45, + "available_qty": 987.65, "is_in_stock": false, "is_pickup_location_active": true, - "name": "xyz789", + "name": "abc123", "sku": "abc123", "source_code": "xyz789" } @@ -3968,9 +3978,37 @@ For retrieving statistics across multiple buckets ```json { - "max": 123.45, - "min": 123.45, - "title": "xyz789" + "max": 987.65, + "min": 987.65, + "title": "abc123" +} +``` + + + +### StockAvailability + +Stock-level availability of a single SKU in the current sales channel's stock. + +#### Fields + +| Field Name | Description | +|------------|-------------| +| `backorder_message` - [`String`](#string) | Customer-facing pre-order notice, populated only when the SKU is salable solely because notify-mode backorders are enabled — it is salable but not in stock; null otherwise (in stock, silent backorders, or not salable). | +| `is_in_stock` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the smallest valid purchase (the minimum sale quantity, rounded up to the quantity increment; one unit by default) can be fulfilled from stock on hand, excluding any backorder allowance. False for a SKU that is purchasable only through backorders. For a SKU whose stock is not tracked, or a composite parent, equal to is_salable. | +| `is_salable` - [`Boolean!`](/reference/graphql/saas/types-a-b.md#boolean) | Whether the SKU can be added to the cart right now in its smallest valid purchase quantity (the minimum sale quantity, rounded up to the quantity increment; one unit by default), backorders considered. This is the authoritative Add to Cart gate. Respects the merchant's stock status override, and for a composite parent (configurable, bundle, grouped) the parent's own stock status: a parent set Out of Stock is not salable even when its children are in stock. True for a SKU whose stock is not tracked (Manage Stock disabled), except that on a custom stock a SKU must be assigned to one of the stock's sources to be salable. | +| `salable_qty` - [`Float`](/reference/graphql/saas/types-f-i.md#float) | Quantity that can be purchased right now: physical quantity across the stock's sources, net of every open reservation and the out-of-stock threshold; the figure the cart enforces. With a negative out-of-stock threshold (backorders allowed down to a limit) it includes that backorder allowance, so it can exceed the physical stock; do not use it as an on-hand count, such as an only-X-left badge. is_in_stock tells whether a purchase can ship from stock on hand. The exact value is returned only when it is at or below the merchant's storefront display threshold (cataloginventory/options/stock_threshold_qty). Null above that threshold, when the SKU's stock is not tracked, or for a composite parent (configurable, bundle, grouped). | +| `sku` - [`String!`](#string) | The product SKU the availability applies to. | + +#### Example + +```json +{ + "backorder_message": "xyz789", + "is_in_stock": true, + "is_salable": false, + "salable_qty": 987.65, + "sku": "abc123" } ``` @@ -4146,163 +4184,163 @@ Contains information about a store's configuration. ```json { - "allow_company_registration": false, - "allow_gift_receipt": "abc123", + "allow_company_registration": true, + "allow_gift_receipt": "xyz789", "allow_gift_wrapping_on_order": "xyz789", "allow_gift_wrapping_on_order_items": "abc123", "allow_guests_to_write_product_reviews": "abc123", - "allow_items": "abc123", + "allow_items": "xyz789", "allow_order": "abc123", "allow_printed_card": "abc123", - "autocomplete_on_storefront": false, - "base_currency_code": "abc123", - "base_link_url": "abc123", - "base_media_url": "xyz789", - "base_static_url": "xyz789", + "autocomplete_on_storefront": true, + "base_currency_code": "xyz789", + "base_link_url": "xyz789", + "base_media_url": "abc123", + "base_static_url": "abc123", "base_url": "abc123", "cart_expires_in_days": 987, "cart_gift_wrapping": "xyz789", "cart_merge_preference": "xyz789", "cart_printed_card": "xyz789", "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", + "category_url_suffix": "xyz789", "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": "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": 987, - "check_money_order_title": "xyz789", + "check_money_order_send_check_to": "abc123", + "check_money_order_sort_order": 123, + "check_money_order_title": "abc123", "company_credit_enabled": true, - "company_enabled": false, + "company_enabled": true, "configurable_product_image": "ITSELF", "configurable_thumbnail_source": "xyz789", - "contact_enabled": true, + "contact_enabled": false, "countries_with_required_region": "abc123", "create_account_confirmation": false, - "customer_access_token_lifetime": 123.45, - "default_country": "abc123", - "default_display_currency_code": "xyz789", - "display_product_prices_in_catalog": 987, + "customer_access_token_lifetime": 987.65, + "default_country": "xyz789", + "default_display_currency_code": "abc123", + "display_product_prices_in_catalog": 123, "display_shipping_prices": 123, "display_state_if_optional": false, "enable_multiple_wishlists": "xyz789", "fixed_product_taxes_apply_tax_to_fpt": false, - "fixed_product_taxes_display_prices_in_emails": 123, + "fixed_product_taxes_display_prices_in_emails": 987, "fixed_product_taxes_display_prices_in_product_lists": 123, - "fixed_product_taxes_display_prices_in_sales_modules": 987, - "fixed_product_taxes_display_prices_on_product_view_page": 987, - "fixed_product_taxes_enable": false, + "fixed_product_taxes_display_prices_in_sales_modules": 123, + "fixed_product_taxes_display_prices_on_product_view_page": 123, + "fixed_product_taxes_enable": true, "fixed_product_taxes_include_fpt_in_subtotal": true, "graphql_share_customer_group": false, "grid_per_page": 123, - "grid_per_page_values": "abc123", + "grid_per_page_values": "xyz789", "grouped_product_image": "ITSELF", "is_checkout_agreements_enabled": true, - "is_default_store": true, + "is_default_store": false, "is_default_store_group": false, "is_guest_checkout_enabled": true, - "is_negotiable_quote_active": true, - "is_one_page_checkout_enabled": false, + "is_negotiable_quote_active": false, + "is_one_page_checkout_enabled": true, "is_requisition_list_active": "xyz789", - "list_mode": "xyz789", - "list_per_page": 987, + "list_mode": "abc123", + "list_per_page": 123, "list_per_page_values": "abc123", - "locale": "xyz789", - "magento_reward_general_is_enabled": "abc123", + "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_publish_history": "xyz789", - "magento_reward_points_invitation_customer": "xyz789", + "magento_reward_points_invitation_customer": "abc123", "magento_reward_points_invitation_customer_limit": "abc123", - "magento_reward_points_invitation_order": "abc123", + "magento_reward_points_invitation_order": "xyz789", "magento_reward_points_invitation_order_limit": "xyz789", "magento_reward_points_newsletter": "xyz789", - "magento_reward_points_order": "abc123", + "magento_reward_points_order": "xyz789", "magento_reward_points_register": "xyz789", "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", + "max_items_in_order_summary": 123, + "maximum_number_of_wishlists": "xyz789", "minicart_display": true, - "minicart_max_items": 123, - "minimum_password_length": "xyz789", - "newsletter_enabled": true, + "minicart_max_items": 987, + "minimum_password_length": "abc123", + "newsletter_enabled": false, "optional_zip_countries": "abc123", - "order_cancellation_enabled": false, + "order_cancellation_enabled": true, "order_cancellation_reasons": [CancellationReason], "orders_invoices_credit_memos_display_full_summary": true, "orders_invoices_credit_memos_display_grandtotal": true, - "orders_invoices_credit_memos_display_price": 987, - "orders_invoices_credit_memos_display_shipping_amount": 123, + "orders_invoices_credit_memos_display_price": 123, + "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": true, + "persistent_enabled": false, "persistent_options_wishlist": true, "persistent_shopping_cart": true, "printed_card_priceV2": Money, - "product_alert_allow_stock": false, + "product_alert_allow_stock": true, "product_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", "product_reviews_enabled": "xyz789", - "product_url_suffix": "xyz789", + "product_url_suffix": "abc123", "quickorder_active": true, - "quote_minimum_amount": 987.65, + "quote_minimum_amount": 123.45, "quote_minimum_amount_message": "abc123", - "required_character_classes_number": "abc123", + "required_character_classes_number": "xyz789", "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_public_sharing_enabled": false, "requisition_list_share_link_validity_days": 123, - "requisition_list_share_max_recipients": 987, - "requisition_list_share_storefront_path": "abc123", - "requisition_list_sharing_enabled": false, - "returns_enabled": "abc123", - "root_category_uid": 4, + "requisition_list_share_max_recipients": 123, + "requisition_list_share_storefront_path": "xyz789", + "requisition_list_sharing_enabled": true, + "returns_enabled": "xyz789", + "root_category_uid": "4", "sales_fixed_product_tax_display_setting": "INCLUDE_FPT_WITHOUT_DETAILS", - "sales_gift_wrapping": "xyz789", + "sales_gift_wrapping": "abc123", "sales_printed_card": "xyz789", - "secure_base_link_url": "xyz789", + "secure_base_link_url": "abc123", "secure_base_media_url": "abc123", - "secure_base_static_url": "abc123", - "secure_base_url": "xyz789", + "secure_base_static_url": "xyz789", + "secure_base_url": "abc123", "share_active_segments": false, "share_applied_cart_rule": true, "share_customer_accounts_scope": 987, - "shopping_assistance_checkbox_title": "abc123", + "shopping_assistance_checkbox_title": "xyz789", "shopping_assistance_checkbox_tooltip": "abc123", "shopping_assistance_enabled": true, "shopping_cart_display_full_summary": false, - "shopping_cart_display_grand_total": true, + "shopping_cart_display_grand_total": false, "shopping_cart_display_price": 123, "shopping_cart_display_shipping": 123, - "shopping_cart_display_subtotal": 123, + "shopping_cart_display_subtotal": 987, "shopping_cart_display_tax_gift_wrapping": "DISPLAY_EXCLUDING_TAX", "shopping_cart_display_zero_tax": true, "store_code": "4", "store_group_code": 4, - "store_group_name": "abc123", + "store_group_name": "xyz789", "store_name": "abc123", - "store_sort_order": 987, - "timezone": "xyz789", - "title_separator": "xyz789", - "use_store_in_url": true, + "store_sort_order": 123, + "timezone": "abc123", + "title_separator": "abc123", + "use_store_in_url": false, "website_code": 4, - "website_name": "xyz789", - "weight_unit": "xyz789", + "website_name": "abc123", + "weight_unit": "abc123", "zero_subtotal_enable_for_specific_countries": false, "zero_subtotal_enabled": false, "zero_subtotal_new_order_status": "xyz789", - "zero_subtotal_payment_action": "xyz789", - "zero_subtotal_payment_from_specific_countries": "xyz789", - "zero_subtotal_sort_order": 987, - "zero_subtotal_title": "xyz789" + "zero_subtotal_payment_action": "abc123", + "zero_subtotal_payment_from_specific_countries": "abc123", + "zero_subtotal_sort_order": 123, + "zero_subtotal_title": "abc123" } ``` @@ -4315,7 +4353,7 @@ The `String` scalar type represents textual data, represented as UTF-8 character #### Example ```json -"xyz789" +"abc123" ``` @@ -4375,14 +4413,14 @@ Specifies the quote template properties to update. ```json { "attachments": [NegotiableQuoteCommentAttachmentInput], - "comment": "abc123", + "comment": "xyz789", "max_order_commitment": 987, - "min_order_commitment": 123, - "name": "abc123", + "min_order_commitment": 987, + "name": "xyz789", "reference_document_links": [ NegotiableQuoteTemplateReferenceDocumentLinkInput ], - "template_id": 4 + "template_id": "4" } ``` @@ -4441,7 +4479,7 @@ Represents the subtree of the categories to retrieve. #### Example ```json -{"depth": 123, "startLevel": 987} +{"depth": 987, "startLevel": 987} ``` 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 ae71e5034..29d0c3807 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 @@ -53,7 +53,7 @@ Contains tax item details. #### Example ```json -{"value": "abc123"} +{"value": "xyz789"} ``` @@ -96,7 +96,7 @@ Defines a price based on the quantity purchased. { "discount": ProductDiscount, "final_price": Money, - "quantity": 987.65 + "quantity": 123.45 } ``` @@ -159,8 +159,8 @@ Contains the response to the request to unassign a child company. { "unitName": "abc123", "storefrontLabel": "xyz789", - "pagePlacement": "xyz789", - "displayNumber": 987, + "pagePlacement": "abc123", + "displayNumber": 123, "pageType": "abc123", "unitStatus": "abc123", "typeId": "abc123", @@ -207,7 +207,7 @@ Modifies the specified items in the cart. ```json { - "cart_id": "xyz789", + "cart_id": "abc123", "cart_items": [CartItemUpdateInput] } ``` @@ -250,7 +250,7 @@ Defines the input schema for updating company configuration. #### Example ```json -{"address_book_enabled": true, "custom_shipping_address_enabled": false} +{"address_book_enabled": false, "custom_shipping_address_enabled": false} ``` @@ -476,10 +476,10 @@ Defines updates to an existing registrant. "dynamic_attributes": [ GiftRegistryDynamicAttributeInput ], - "email": "xyz789", - "firstname": "xyz789", + "email": "abc123", + "firstname": "abc123", "gift_registry_registrant_uid": 4, - "lastname": "xyz789" + "lastname": "abc123" } ``` @@ -629,9 +629,9 @@ Defines the changes to be made to an approval rule. "approvers": ["4"], "condition": CreatePurchaseOrderApprovalRuleConditionInput, "description": "abc123", - "name": "abc123", + "name": "xyz789", "status": "ENABLED", - "uid": 4 + "uid": "4" } ``` @@ -653,9 +653,9 @@ An input object that defines which requistion list characteristics to update. ```json { - "description": "xyz789", - "is_public": true, - "name": "xyz789" + "description": "abc123", + "is_public": false, + "name": "abc123" } ``` @@ -680,7 +680,7 @@ Defines which items in a requisition list to update. { "entered_options": [EnteredOptionInput], "item_id": "4", - "quantity": 123.45, + "quantity": 987.65, "selected_options": ["xyz789"] } ``` @@ -739,7 +739,7 @@ Contains the name and visibility of an updated wish list. ```json { - "name": "xyz789", + "name": "abc123", "uid": "4", "visibility": "PUBLIC" } @@ -763,8 +763,8 @@ Defines the input for returning matching companies the customer is assigned to. ```json { - "currentPage": 987, - "pageSize": 123, + "currentPage": 123, + "pageSize": 987, "sort": [CompaniesSortInput] } ``` @@ -977,10 +977,10 @@ Vault payment inputs ```json { - "payment_source": "abc123", - "payments_order_id": "abc123", + "payment_source": "xyz789", + "payments_order_id": "xyz789", "paypal_order_id": "abc123", - "public_hash": "xyz789" + "public_hash": "abc123" } ``` @@ -1020,7 +1020,7 @@ User view history ```json { "date": "2007-12-03T10:15:30Z", - "sku": "xyz789" + "sku": "abc123" } ``` @@ -1085,11 +1085,11 @@ An implementation for virtual product cart items. "customizable_options": [SelectedCustomizableOption], "discount": [Discount], "errors": [CartItemError], - "is_available": true, - "is_free_gift": false, - "is_salable": false, + "is_available": false, + "is_free_gift": true, + "is_salable": true, "max_qty": 123.45, - "min_qty": 987.65, + "min_qty": 123.45, "nominated_source": SourceAvailability, "nominated_source_errors": [NominatedSourceError], "not_available_message": "abc123", @@ -1097,8 +1097,8 @@ An implementation for virtual product cart items. "note_from_seller": [ItemNote], "prices": CartItemPrices, "product": ProductInterface, - "quantity": 123.45, - "uid": 4 + "quantity": 987.65, + "uid": "4" } ``` @@ -1162,41 +1162,41 @@ Defines a virtual product, which is a non-tangible product that does not require { "canonical_url": "abc123", "categories": [CategoryInterface], - "country_of_manufacture": "abc123", + "country_of_manufacture": "xyz789", "crosssell_products": [ProductInterface], "custom_attributesV2": ProductCustomAttributes, "description": ComplexTextValue, "gift_message_available": true, - "gift_wrapping_available": true, + "gift_wrapping_available": false, "gift_wrapping_price": Money, "image": ProductImage, "is_returnable": "xyz789", - "manufacturer": 123, + "manufacturer": 987, "max_sale_qty": 123.45, "media_gallery": [MediaGalleryInterface], "meta_description": "abc123", - "meta_keyword": "xyz789", - "meta_title": "xyz789", + "meta_keyword": "abc123", + "meta_title": "abc123", "min_sale_qty": 123.45, - "name": "abc123", + "name": "xyz789", "new_from_date": "abc123", - "new_to_date": "abc123", + "new_to_date": "xyz789", "only_x_left_in_stock": 123.45, "options": [CustomizableOptionInterface], - "options_container": "xyz789", + "options_container": "abc123", "price_range": PriceRange, "price_tiers": [TierPrice], "product_links": [ProductLinksInterface], - "quantity": 123.45, + "quantity": 987.65, "rating_summary": 123.45, "related_products": [ProductInterface], "review_count": 987, "reviews": ProductReviews, "short_description": ComplexTextValue, - "sku": "xyz789", + "sku": "abc123", "small_image": ProductImage, "special_price": 123.45, - "special_to_date": "xyz789", + "special_to_date": "abc123", "stock_status": "IN_STOCK", "swatch_image": "xyz789", "thumbnail": ProductImage, @@ -1229,8 +1229,8 @@ Contains details about virtual products added to a requisition list. "customizable_options": [SelectedCustomizableOption], "product": ProductInterface, "quantity": 123.45, - "sku": "abc123", - "uid": "4" + "sku": "xyz789", + "uid": 4 } ``` @@ -1260,7 +1260,7 @@ Contains a virtual product wish list item. "description": "abc123", "id": 4, "product": ProductInterface, - "quantity": 123.45 + "quantity": 987.65 } ``` @@ -1282,7 +1282,7 @@ An error encountered while performing operations with WishList. ```json { "code": "PRODUCT_NOT_FOUND", - "message": "abc123" + "message": "xyz789" } ``` @@ -1328,11 +1328,11 @@ Contains a customer wish list. ```json { "id": "4", - "items_count": 987, + "items_count": 123, "items_v2": WishlistItems, - "name": "abc123", - "sharing_code": "abc123", - "updated_at": "abc123", + "name": "xyz789", + "sharing_code": "xyz789", + "updated_at": "xyz789", "visibility": "PUBLIC" } ``` @@ -1357,9 +1357,9 @@ Contains details about errors encountered when a customer added wish list items ```json { "code": "PRODUCT_NOT_FOUND", - "message": "xyz789", - "wishlistId": "4", - "wishlistItemId": 4 + "message": "abc123", + "wishlistId": 4, + "wishlistItemId": "4" } ``` @@ -1430,7 +1430,7 @@ Defines the items to add to a wish list. "entered_options": [EnteredOptionInput], "parent_sku": "xyz789", "quantity": 123.45, - "selected_options": [4], + "selected_options": ["4"], "sku": "xyz789" } ``` @@ -1468,12 +1468,12 @@ The interface for wish list items. ```json { - "added_at": "xyz789", + "added_at": "abc123", "customizable_options": [SelectedCustomizableOption], - "description": "abc123", - "id": "4", + "description": "xyz789", + "id": 4, "product": ProductInterface, - "quantity": 987.65 + "quantity": 123.45 } ```