JB Hi-Fi · Schema

Jb Hi Fi Ucp Mcp Tools List

CompanyRetailConsumer ElectronicsE-CommerceHome EntertainmentAustraliaAgentic Commerce
View JSON Schema on GitHub

JSON Schema

jb-hi-fi-ucp-mcp-tools-list.json Raw ↑
{"jsonrpc":"2.0","id":2,"result":{"tools":[{"name":"get_checkout","description":"Returns details about the checkout, including line items, totals, and any applicable discounts or taxes.\n\nPrices in the response are integers in the currency's ISO 4217 minor units, paired with\na currency code: {\"amount\": 600, \"currency\": \"USD\"} is $6.00 and {\"amount\": 2500,\n\"currency\": \"USD\"} is $25.00. Convert to major units before quoting a price to a buyer\n(divide by 100 for two-decimal currencies such as USD and EUR; zero-decimal currencies\nsuch as JPY are already whole units).\n\n","inputSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"meta":{"type":"object","description":"Metadata for UCP agent profile discovery.","properties":{"ucp-agent":{"type":"object","properties":{"profile":{"type":"string","format":"uri","description":"Agent profile URI for UCP discovery."}},"required":["profile"]}},"required":["ucp-agent"]},"id":{"type":"string","description":"The ID of the checkout to update. Format: 'gid://shopify/Checkout/abc123'"}},"required":["meta","id"]},"outputSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","title":"Checkout or receipt response","description":"The open checkout, or a receipt when the checkout has already been submitted.","oneOf":[{"type":"object","title":"Checkout response","description":"Structured checkout content returned while the checkout is still open.","required":["ucp","id","line_items","status","currency","totals","links"],"additionalProperties":true,"properties":{"ucp":{"type":"object","description":"UCP protocol metadata for the response.","required":["version","status","services","capabilities","payment_handlers"],"additionalProperties":true,"properties":{"version":{"type":"string","description":"The negotiated UCP version."},"status":{"type":"string","enum":["success","error"],"description":"Whether UCP processing succeeded."},"services":{"type":"object","description":"Services available to the agent.","additionalProperties":true},"capabilities":{"type":"object","description":"Negotiated UCP capabilities.","additionalProperties":true},"payment_handlers":{"type":"object","description":"Payment handlers available to the buyer. Empty on receipts.","additionalProperties":true}}},"id":{"type":"string","description":"The Shopify Checkout GID."},"status":{"type":"string","description":"The checkout status.","enum":["incomplete","requires_escalation","ready_for_complete","canceled"]},"currency":{"type":"string","description":"The presentment currency code (ISO 4217)."},"buyer":{"type":"object","description":"Information about the buyer.","additionalProperties":true,"properties":{"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"consent":{"type":"object","description":"Current buyer consent decisions and business defaults, keyed by purpose.","additionalProperties":{"type":"object","required":["granted","source","description"],"additionalProperties":true,"properties":{"granted":{"type":"boolean"},"source":{"type":"string","enum":["business","platform"]},"description":{"type":"string"},"segments":{"type":"object","additionalProperties":{"type":"object","required":["granted","source","description"],"additionalProperties":true,"properties":{"granted":{"type":"boolean"},"source":{"type":"string","enum":["business","platform"]},"description":{"type":"string"}}}}}}}}},"line_items":{"type":"array","description":"Line items in the checkout.","items":{"type":"object","required":["id","item","quantity","totals"],"additionalProperties":true,"properties":{"id":{"type":"string","description":"The line item ID."},"item":{"type":"object","description":"The merchandise item for a line item.","required":["id","title","price"],"additionalProperties":true,"properties":{"id":{"type":"string","description":"The product variant GID."},"title":{"type":"string","description":"The item title."},"price":{"type":"integer","description":"The unit price in minor currency units."},"image_url":{"type":"string","format":"uri","description":"The item image URL."}}},"quantity":{"type":"integer","description":"The line item quantity."},"totals":{"type":"array","description":"Monetary totals in minor currency units.","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string","description":"Cost category. Well-known values: subtotal, items_discount, discount, fulfillment, tax, fee, total. Businesses may use additional values, which always carry `display_text` (Shopify emits `duty`)."},"amount":{"type":"integer","description":"The amount in minor currency units. Discount totals are negative."},"display_text":{"type":"string","description":"Buyer-facing label for the total."}}}},"parent_id":{"type":"string","description":"The parent line item ID for nested line items."}}}},"totals":{"type":"array","description":"Monetary totals in minor currency units.","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string","description":"Cost category. Well-known values: subtotal, items_discount, discount, fulfillment, tax, fee, total. Businesses may use additional values, which always carry `display_text` (Shopify emits `duty`)."},"amount":{"type":"integer","description":"The amount in minor currency units. Discount totals are negative."},"display_text":{"type":"string","description":"Buyer-facing label for the total."}}}},"expires_at":{"type":"string","format":"date-time","description":"The date and time when the checkout expires."},"attribution":{"type":"object","description":"Marketing attribution context for the buyer's session.","additionalProperties":true,"properties":{"referring_domain":{"type":"string"},"click_id_tag":{"type":"string"},"click_id_value":{"type":"string"},"activity_id_tag":{"type":"string"},"activity_id_value":{"type":"string"},"utm_campaign":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_content":{"type":"string"},"utm_term":{"type":"string"}}},"links":{"type":"array","description":"Merchant policy links relevant to the checkout.","items":{"type":"object","required":["type","url"],"additionalProperties":true,"properties":{"type":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri","description":"The policy URL."}}}},"payment":{"type":"object","description":"Payment information for the checkout.","additionalProperties":true,"properties":{"instruments":{"type":"array","description":"Payment instruments available to or selected by the buyer.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"handler_id":{"type":"string"},"type":{"type":"string"},"selected":{"type":"boolean"},"credential":{"type":"object","additionalProperties":true,"properties":{"type":{"type":"string"}}},"billing_address":{"type":"object","description":"Mailing address fields.","additionalProperties":true,"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"postal_code":{"type":"string"},"address_country":{"type":"string"}}},"display":{"type":["object","null"],"description":"Handler-specific display data (for example card brand and last digits).","additionalProperties":true}}}}}},"messages":{"type":"array","description":"Errors or warnings surfaced while processing the tool call.","items":{"type":"object","required":["type"],"additionalProperties":true,"properties":{"type":{"type":"string","enum":["error","warning","info"]},"content_type":{"type":"string","enum":["plain","markdown"]},"code":{"type":"string"},"content":{"type":"string"},"severity":{"type":"string","enum":["recoverable","requires_buyer_input","requires_buyer_review","unrecoverable"]},"path":{"type":"string"}}}},"continue_url":{"type":"string","format":"uri","description":"The URL where the buyer can continue checkout."},"fulfillment":{"type":"object","description":"Fulfillment methods, destinations, delivery groups, and delivery options.","additionalProperties":true,"properties":{"methods":{"type":"array","description":"Fulfillment methods available for the checkout or cart.","items":{"type":"object","required":["id","type","line_item_ids"],"additionalProperties":true,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup"]},"line_item_ids":{"type":"array","description":"Line item IDs covered by this fulfillment method.","items":{"type":"string"}},"selected_destination_id":{"type":["string","null"]},"destinations":{"type":"array","description":"Destinations available for this fulfillment method.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"postal_code":{"type":"string"},"address_country":{"type":"string"}}}},"groups":{"type":"array","description":"Delivery groups for this fulfillment method.","items":{"type":"object","required":["id","line_item_ids"],"additionalProperties":true,"properties":{"id":{"type":"string"},"line_item_ids":{"type":"array","items":{"type":"string"}},"selected_option_id":{"type":["string","null"]},"options":{"type":"array","description":"Delivery options available for the group.","items":{"type":"object","required":["id"],"additionalProperties":true,"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"object","description":"Buyer-facing description of the delivery option.","additionalProperties":true,"properties":{"plain":{"type":"string"}}},"totals":{"type":"array","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string"},"amount":{"type":"integer","description":"The amount in minor currency units."}}}}}}}}}}}}}}},"discounts":{"type":"object","description":"Discount codes and applied discounts for the checkout or cart.","additionalProperties":true,"properties":{"codes":{"type":"array","description":"Discount codes submitted for the checkout or cart.","items":{"type":"string"}},"applied":{"type":"array","description":"Discounts applied to the checkout or cart, including automatic discounts.","items":{"type":"object","required":["title","amount"],"additionalProperties":true,"properties":{"code":{"type":"string"},"title":{"type":"string"},"amount":{"type":"integer","description":"The discount amount in minor currency units."},"method":{"type":"string","description":"How the discount is allocated across the targeted items.","enum":["each","across","one"]},"automatic":{"type":"boolean"},"allocations":{"type":"array","description":"Line item or fulfillment total allocations of the discount.","items":{"type":"object","required":["path","amount"],"additionalProperties":true,"properties":{"path":{"type":"string","description":"JSONPath to the discounted line item or total."},"amount":{"type":"integer","description":"The allocated amount in minor currency units."}}}}}}}}}}},{"type":"object","title":"Receipt response","description":"Structured receipt content returned once the checkout has been submitted.","required":["ucp","id","status","currency","totals"],"additionalProperties":true,"properties":{"ucp":{"type":"object","description":"UCP protocol metadata for the response.","required":["version","status","services","capabilities","payment_handlers"],"additionalProperties":true,"properties":{"version":{"type":"string","description":"The negotiated UCP version."},"status":{"type":"string","enum":["success","error"],"description":"Whether UCP processing succeeded."},"services":{"type":"object","description":"Services available to the agent.","additionalProperties":true},"capabilities":{"type":"object","description":"Negotiated UCP capabilities.","additionalProperties":true},"payment_handlers":{"type":"object","description":"Payment handlers available to the buyer. Empty on receipts.","additionalProperties":true}}},"id":{"type":"string","description":"The Shopify Checkout GID."},"status":{"type":"string","description":"The checkout status after submission.","enum":["complete_in_progress","completed"]},"currency":{"type":"string","description":"The presentment currency code (ISO 4217)."},"line_items":{"type":"array","description":"Line items in the checkout.","items":{"type":"object","required":["id","item","quantity","totals"],"additionalProperties":true,"properties":{"id":{"type":"string","description":"The line item ID."},"item":{"type":"object","description":"The merchandise item for a line item.","required":["title","price"],"additionalProperties":true,"properties":{"id":{"type":"string","description":"The product variant GID."},"title":{"type":"string","description":"The item title."},"price":{"type":"integer","description":"The unit price in minor currency units."},"image_url":{"type":"string","format":"uri","description":"The item image URL."}}},"quantity":{"type":"integer","description":"The line item quantity."},"totals":{"type":"array","description":"Monetary totals in minor currency units.","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string","description":"Cost category. Well-known values: subtotal, items_discount, discount, fulfillment, tax, fee, total. Businesses may use additional values, which always carry `display_text` (Shopify emits `duty`)."},"amount":{"type":"integer","description":"The amount in minor currency units. Discount totals are negative."},"display_text":{"type":"string","description":"Buyer-facing label for the total."}}}},"parent_id":{"type":"string","description":"The parent line item ID for nested line items."}}}},"totals":{"type":"array","description":"Monetary totals in minor currency units.","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string","description":"Cost category. Well-known values: subtotal, items_discount, discount, fulfillment, tax, fee, total. Businesses may use additional values, which always carry `display_text` (Shopify emits `duty`)."},"amount":{"type":"integer","description":"The amount in minor currency units. Discount totals are negative."},"display_text":{"type":"string","description":"Buyer-facing label for the total."}}}},"buyer":{"type":"object","description":"Information about the buyer.","additionalProperties":true,"properties":{"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"consent":{"type":"object","description":"Current buyer consent decisions and business defaults, keyed by purpose.","additionalProperties":{"type":"object","required":["granted","source","description"],"additionalProperties":true,"properties":{"granted":{"type":"boolean"},"source":{"type":"string","enum":["business","platform"]},"description":{"type":"string"},"segments":{"type":"object","additionalProperties":{"type":"object","required":["granted","source","description"],"additionalProperties":true,"properties":{"granted":{"type":"boolean"},"source":{"type":"string","enum":["business","platform"]},"description":{"type":"string"}}}}}}}}},"payment":{"type":"object","description":"Payment summary for the completed checkout.","additionalProperties":true,"properties":{"handlers":{"type":"object","description":"Payment handlers accepted by the merchant.","additionalProperties":true},"instruments":{"type":"array","description":"Payment instruments used for the order.","items":{"type":"object","additionalProperties":true}}}},"order":{"type":"object","description":"Order confirmation. Present once the checkout has completed.","required":["id","permalink_url"],"additionalProperties":true,"properties":{"id":{"type":"string","description":"The order GID."},"label":{"type":"string","description":"The buyer-facing order label."},"permalink_url":{"type":"string","format":"uri","description":"The order status URL."}}},"links":{"type":"array","description":"Merchant policy links relevant to the checkout.","items":{"type":"object","required":["type","url"],"additionalProperties":true,"properties":{"type":{"type":"string"},"title":{"type":"string"},"url":{"type":"string","format":"uri","description":"The policy URL."}}}},"messages":{"type":"array","description":"Errors or warnings surfaced while processing the tool call.","items":{"type":"object","required":["type"],"additionalProperties":true,"properties":{"type":{"type":"string","enum":["error","warning","info"]},"content_type":{"type":"string","enum":["plain","markdown"]},"code":{"type":"string"},"content":{"type":"string"},"severity":{"type":"string","enum":["recoverable","requires_buyer_input","requires_buyer_review","unrecoverable"]},"path":{"type":"string"}}}},"fulfillment":{"type":"object","description":"Fulfillment methods, destinations, delivery groups, and delivery options.","additionalProperties":true,"properties":{"methods":{"type":"array","description":"Fulfillment methods available for the checkout or cart.","items":{"type":"object","required":["id","type","line_item_ids"],"additionalProperties":true,"properties":{"id":{"type":"string"},"type":{"type":"string","enum":["shipping","pickup"]},"line_item_ids":{"type":"array","description":"Line item IDs covered by this fulfillment method.","items":{"type":"string"}},"selected_destination_id":{"type":["string","null"]},"destinations":{"type":"array","description":"Destinations available for this fulfillment method.","items":{"type":"object","additionalProperties":true,"properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"postal_code":{"type":"string"},"address_country":{"type":"string"}}}},"groups":{"type":"array","description":"Delivery groups for this fulfillment method.","items":{"type":"object","required":["id","line_item_ids"],"additionalProperties":true,"properties":{"id":{"type":"string"},"line_item_ids":{"type":"array","items":{"type":"string"}},"selected_option_id":{"type":["string","null"]},"options":{"type":"array","description":"Delivery options available for the group.","items":{"type":"object","required":["id"],"additionalProperties":true,"properties":{"id":{"type":"string"},"title":{"type":"string"},"description":{"type":"object","description":"Buyer-facing description of the delivery option.","additionalProperties":true,"properties":{"plain":{"type":"string"}}},"totals":{"type":"array","items":{"type":"object","required":["type","amount"],"additionalProperties":true,"properties":{"type":{"type":"string"},"amount":{"type":"integer","description":"The amount in minor currency units."}}}}}}}}}}}}}}},"discounts":{"type":"object","description":"Discount codes and applied discounts for the checkout or cart.","additionalProperties":true,"properties":{"codes":{"type":"array","description":"Discount codes submitted for the checkout or cart.","items":{"type":"string"}},"applied":{"type":"array","description":"Discounts applied to the checkout or cart, including automatic discounts.","items":{"type":"object","required":["title","amount"],"additionalProperties":true,"properties":{"code":{"type":"string"},"title":{"type":"string"},"amount":{"type":"integer","description":"The discount amount in minor currency units."},"method":{"type":"string","description":"How the discount is allocated across the targeted items.","enum":["each","across","one"]},"automatic":{"type":"boolean"},"allocations":{"type":"array","description":"Line item or fulfillment total allocations of the discount.","items":{"type":"object","required":["path","amount"],"additionalProperties":true,"properties":{"path":{"type":"string","description":"JSONPath to the discounted line item or total."},"amount":{"type":"integer","description":"The allocated amount in minor currency units."}}}}}}}}}}}]}},{"name":"create_checkout","description":"Creates a checkout. Returns checkout details, including line items, totals, and any applicable discounts or taxes.\n\nPrices in the response are integers in the currency's ISO 4217 minor units, paired with\na currency code: {\"amount\": 600, \"currency\": \"USD\"} is $6.00 and {\"amount\": 2500,\n\"currency\": \"USD\"} is $25.00. Convert to major units before quoting a price to a buyer\n(divide by 100 for two-decimal currencies such as USD and EUR; zero-decimal currencies\nsuch as JPY are already whole units).\n\n","inputSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"meta":{"type":"object","description":"Metadata for UCP agent profile discovery.","properties":{"ucp-agent":{"type":"object","properties":{"profile":{"type":"string","format":"uri","description":"Agent profile URI for UCP discovery."}},"required":["profile"]}},"required":["ucp-agent"]},"checkout":{"type":"object","description":"Checkout properties.","properties":{"payment":{"type":"object","description":"Payment information for this checkout.","additionalProperties":true,"properties":{"instruments":{"type":"array","description":"Payment instruments for this checkout (e.g., credit cards, tokens, wallets).","items":{"type":"object","required":["id","handler_id","type"],"additionalProperties":true,"allOf":[{"if":{"properties":{"handler_id":{"const":"apple-pay"}},"required":["handler_id"]},"then":{"required":["billing_address","credential"],"properties":{"type":{"const":"card"},"credential":{"properties":{"type":{"const":"apple_pay_token"}},"required":["type","payment_data"]}}},"else":{"properties":{"credential":{"required":["type"],"properties":{"type":{"not":{"const":"apple_pay_token"}}}}}}}],"properties":{"id":{"type":"string","description":"A unique identifier for this payment instrument instance."},"handler_id":{"type":"string","description":"Identifier of the payment handler that was used to generate this instrument."},"type":{"type":"string","description":"Instrument type. Apple Pay uses 'card' because the submitted instrument represents a tokenized card."},"billing_address":{"type":"object","description":"Billing address for the instrument.","additionalProperties":true,"properties":{"street_address":{"type":"string","description":"Street address of the billing address."},"extended_address":{"type":"string","description":"Extended address of the billing address such as an apartment number, C/O, or alternative name."},"address_locality":{"type":"string","description":"Locality of the billing address."},"address_region":{"type":"string","description":"Region of the billing address."},"postal_code":{"type":"string","description":"Postal code of the billing address."},"address_country":{"type":"string","description":"Country of the billing address in 2-letter ISO 3166-1 alpha-2 format."},"first_name":{"type":"string","description":"First name of the contact associated with the billing address."},"last_name":{"type":"string","description":"Last name of the contact associated with the billing address."},"phone_number":{"type":"string","description":"Phone number of the contact associated with the billing address."}}},"credential":{"type":"object","description":"Payment credential payload to process the transaction for this instrument.","additionalProperties":true,"allOf":[{"if":{"properties":{"type":{"const":"apple_pay_token"}},"required":["type"]},"then":{"required":["type","payment_data"],"properties":{"type":{"const":"apple_pay_token"},"payment_data":{"type":"object","required":["version","data","signature","header"],"additionalProperties":true,"properties":{"version":{"type":"string"},"data":{"type":"string"},"signature":{"type":"string"},"header":{"type":"object","required":["public_key_hash","transaction_id"],"anyOf":[{"required":["ephemeral_public_key"]},{"required":["wrapped_key"]}],"additionalProperties":true,"properties":{"ephemeral_public_key":{"type":"string"},"wrapped_key":{"type":"string"},"public_key_hash":{"type":"string"},"transaction_id":{"type":"string"},"application_data":{"type":"string"}}}}},"transaction_identifier":{"type":"string"}}},"else":{"required":["type"]}}],"properties":{"token":{"type":"string","description":"Opaque payment token value, required except when restating a platform-listed instrument (e.g., a Shop Pay wallet card) whose token the platform re-derives from the instrument id."},"type":{"type":"string","description":"Namespaced token type using dot notation (e.g., stripe.token, merchant.token, google.pay)."},"payment_data":{"type":"object"},"transaction_identifier":{"type":"string"},"approval_id":{"type":"string","description":"Identifier of the payment approval authorizing this credential, as returned by the approvals API. Required for shop_pay credentials when the merchant requires payment approvals."}}},"display":{"type":"object","description":"Display information for this payment instrument.","additionalProperties":true,"properties":{"brand":{"type":"string","description":"Card brand (e.g., visa, mastercard), when available."},"last_digits":{"type":"string","description":"Last 4 digits of the card, when available."},"expiry_month":{"type":"integer","description":"Card expiry month (1-12). Required for card instruments."},"expiry_year":{"type":"integer","description":"Card expiry year. Required for card instruments."},"rich_text_description":{"type":"string","description":"Rich text description of the payment instrument for display purposes."},"rich_card_art":{"type":"string","description":"Rich card art URL or identifier for the payment instrument."},"funding_source":{"type":"string","enum":["debit","credit","prepaid","store"],"description":"How the card is funded, as reported by Apple Pay."}}},"selected":{"type":"boolean","description":"Whether this instrument is the currently selected for the checkout."}}}}}},"line_items":{"type":"array","description":"Items to add to the cart or checkout. Required when creating a new cart or checkout.","items":{"type":"object","required":["item","quantity"],"properties":{"id":{"type":"string","description":"The ID of the line item to update."},"quantity":{"type":"integer"},"item":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"The Product Variant ID to add or update."}}}}}},"buyer":{"type":"object","description":"Information about the buyer including email and phone number.","additionalProperties":true,"properties":{"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"consent":{"type":"object","description":"Per-purpose buyer consent decisions, keyed by reverse-DNS identifiers. Omission leaves existing choices unchanged.","additionalProperties":{"type":"object","required":["granted","source"],"additionalProperties":true,"properties":{"granted":{"type":"boolean","description":"Whether consent is granted."},"source":{"type":"string","enum":["business","platform"],"description":"Use platform for an explicit buyer decision. Business-sourced values do not update stored choices."},"segments":{"type":"object","description":"One level of refinements. Marketing supports dev.ucp.consent.marketing.email and dev.ucp.consent.marketing.sms; a segment overrides its parent.","additionalProperties":{"type":"object","required":["granted","source"],"additionalProperties":true,"properties":{"granted":{"type":"boolean","description":"Whether consent is granted."},"source":{"type":"string","enum":["business","platform"],"description":"Use platform for an explicit buyer decision. Business-sourced values do not update stored choices."}}}}}}}}},"context":{"type":"object","description":"Provisional context hints for localization and pricing. Used when authoritative data (e.g., shipping address) is missing; higher-resolution data supersedes these values and unsupported hints may be ignored without error.","additionalProperties":true,"properties":{"address_country":{"type":"string","description":"Country hint for localization."},"address_region":{"type":"string","description":"Region/state hint for localization."},"postal_code":{"type":"string","description":"Postal code hint for localization."},"intent":{"type":"string","description":"Context describing buyer's intent."},"language":{"type":"string","description":"Language tag in IETF BCP 47 format."},"currency":{"type":"string","description":"Preferred currency (ISO 4217, e.g., 'EUR', 'USD')."},"eligibility":{"type":"array","description":"Buyer claims about eligible benefits such as loyalty membership, payment perks, and similar.","items":{"type":"string","description":"Reverse-domain identifier. Must contain at least two dot-separated segments (e.g., 'com.example.loyalty').","pattern":"^[a-z](?:[a-z0-9-]*[a-z0-9])?(?:\\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9_])?)+$"}}}},"attribution":{"type":"object","description":"Marketing attribution context for the buyer's session (referring domain, click IDs, UTM parameters).","properties":{"referring_domain":{"type":"string","description":"Domain that referred the buyer to the merchant's storefront."},"click_id_tag":{"type":"string","description":"Click identifier parameter name (e.g., 'gclid', 'fbclid')."},"click_id_value":{"type":"string","description":"Click identifier value matching click_id_tag."},"activity_id_tag":{"type":"string","description":"Activity identifier parameter name."},"activity_id_value":{"type":"string","description":"Activity identifier value matching activity_id_tag."},"utm_campaign":{"type":"string","description":"UTM campaign parameter."},"utm_source":{"type":"string","description":"UTM source parameter."},"utm_medium":{"type":"string","description":"UTM medium parameter."},"utm_content":{"type":"string","description":"UTM content parameter."},"utm_term":{"type":"string","description":"UTM term parameter."}}},"cart_id":{"type":"string","description":"Cart ID to convert to checkout. When provided, the business uses cart contents (line_items, context, buyer) and ignores overlapping fields in the checkout payload. line_items is still required: pass an empty array (\"line_items\": []). Format: 'gid://shopify/Cart/abc123?key=secret'"},"fulfillment":{"type":"object","description":"Information about the fulfillment.","properties":{"methods":{"type":"array","description":"The methods of fulfillment.","items":{"type":"object","properties":{"type":{"type":"string"},"line_item_ids":{"type":"array","description":"The line item ids to fulfill.","items":{"type":"string"}},"selected_destination_id":{"type":"string","description":"ID of the selected destination."},"destinations":{"type":"array","description":"The destinations to fulfill to.","items":{"type":"object","properties":{"id":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"phone_number":{"type":"string"},"street_address":{"type":"string"},"extended_address":{"type":"string"},"address_locality":{"type":"string"},"address_region":{"type":"string"},"postal_code":{"type":"string"},"address_country":{"type":"string"}}}},"groups":{"type":"array","description":"The groups to fulfill to.","items":{"type":"object","properties":{"id":{"type":"string"},"selected_option_id":{"type":"string"}}}}},"required":["type"]}}}},"discounts":{"type":"object","description":"Discount or promo codes to apply to the cart. Only prompt if customer mentions having a discount code.","properties":{"codes":{"type":"array","description":"Discount codes to apply. Case-insensitive. Replaces previously submitted codes. Send empty array to clear.","items":{"type":"string"}}}}},"required":["line_items"]}},"required":["meta","checkout"]},"outputSchema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","title":"Checkout response","description":"Structured checkout content returned while the checkout is still open.","required":["ucp","id","line_items","status","currency","totals","links"],"additionalProperties":true,"properties":{"ucp":{"type":"object","description":"UCP protocol metadata for the response.","required":["version","status","services","capabilities","payment_handlers"],"additionalProperties":true,"properties":{"version":{"type":"string","description":"The negotiated UCP version."},"status":{"type":"string","enum":["success","error"],"description":"Whether UCP processing succeeded."},"services":{"type":"object","description":"Services

# --- truncated at 32 KB (185 KB total) ---
# Full source: https://artifacts.apis.io/jb-hi-fi/json-schema/jb-hi-fi-ucp-mcp-tools-list.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/jb-hi-fi-ucp-mcp-tools-list"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.